Mit Hilfe von Funktionselementen kann man auf Versionen zugreifen. So können mit dem content-get
-Element beispielsweise die Werte sämtlicher Versionsparameter ermittelt werden. Um zu spezifizieren, welche Versionsfelder ausgelesen oder gesetzt werden sollen, verwendet man jedoch Parameterelemente. Im Folgenden werden die Parameterelemente für Versionen aufgeführt.
anchors
|
---|
Bedeutung: Liste der Ankernamen in der Version (nur bei Dateien vom Typ publication oder document ). |
Definition: <!ELEMENT anchors (listitem)*> <!ELEMENT listitem (%cm.atom; | listitem | dictitem)*> <!ELEMENT dictitem (key, value)> <!ELEMENT key (%cm.atom;)> <!ELEMENT value (%cm.atom; | listitem | dictitem)*> |
blob
|
---|
Bedeutung: Der Inhalt zur Version. Je nach Datei, zu der die Version gehört, werden ggf. im Inhalt vorkommende URLs wie im Export zurückgegeben. Siehe obj-create auf <obj-create> zur Erläuterung der Werte des Attributs encoding . |
Definition: <!ELEMENT blob (%cm.atom;)> <!ATTLIST blob encoding (plain | base64 | stream) #IMPLIED > |
blobLength
|
---|
Bedeutung: Liefert bei Dateien vom Typ image (Bild ) und generic (Ressource) die Länge der Binärdaten, bei Dateien der anderen Typen die Größe des Hauptinhalts in Bytes. |
Definition: <!ELEMENT blobLength (%cm.atom;)> |
body
|
---|
Bedeutung: Nur bei Layouts, Ordnern und Dokumenten: Vorverarbeitete Version des HTML-Codes der Version, die für interne Zwecke verwendet wird. |
Definition: <!ELEMENT body (%cm.atom;)> |
channels
|
---|
Bedeutung: Liste der Channels, zu denen die Version auf dem Live-Server gehört (nicht bei Dateien vom Typ Layout). |
Definition: <!ELEMENT channels ((channel)* | (listitem)*)> <!ELEMENT channel (%cm.atom; | %cm.channel-get;)*> <!ELEMENT listitem (%cm.atom; | listitem | dictitem)*> <!ELEMENT dictitem (key, value)> <!ELEMENT key (%cm.atom;)> <!ELEMENT value (%cm.atom; | listitem | dictitem)*> cm.channel-get: siehe <channel-where> <channel-get> oder CRUL als DTD. |
codeForPreview
|
---|
Bedeutung: Liefert den vom Content Manager berechneten Code für die Vorschauseite einer Version. In der gelieferten Zeichenkette sind die XML-spezifischen Zeichen wie ’<’ in die entsprechenden XML-Zeichen-Referenzen umgewandelt. |
Definition: <!ELEMENT codeForPreview (%cm.atom;)> <!ATTLIST codeForPreview attributeName CDATA #REQUIRED previewPageUrlSuffix CDATA #REQUIRED frameName CDATA #IMPLIED > Bedeutung der Attribute:
Beispiel: <cm-request...> <content-where> <objectId>43265</objectId> <state>edited</state> </content-where> <content-get> <codeForPreview attributeName="blob" previewPageUrlSuffix="http://my.server.de:3001/...html"/> </content-get> </cm-request> <cm-response...> <cm-code numeric="0" phrase="ok"> <content> <codeForPreview attributeName="blob" previewPageUrlSuffix="http://my.server.de:3001/...html"> der Code für die Vorschauseite (gequotet) </codeForPreview> </content> </cm-code> </cm-response> |
codeForSourceView
|
---|
Bedeutung: Liefert den vom Content Manager berechneten Code für den Quelltext einer Version. In der gelieferten Zeichenkette sind die XML-spezifischen Zeichen wie ’<’ in die entsprechenden XML-Zeichen-Referenzen umgewandelt. |
Definition: <!ELEMENT codeForSourceView (%cm.atom;)> <!ATTLIST codeForSourceView attributeName CDATA #REQUIRED objectPageUrl CDATA #REQUIRED linkPageUrl CDATA #REQUIRED linkIconUrl CDATA #REQUIRED useJavaScript CDATA #IMPLIED > Bedeutung der Attribute:
Beispiel: <cm-request...> <content-where> <objectId>5765</objectId> <state>edited</state> </content-where> <content-get> <codeForSourceView attributeName="body" objectPageUrl="http://my.server.de:...html?display=default&count=100" linkPageUrl="http://my.server.de:3001/CM/CMLinkEditPage/" linkIconUrl="/images/link.gif"/> </content-get> </cm-request> <cm-response...> <cm-code numeric="0" phrase="ok"> <content> <codeForSourceView attributeName="body" objectPageUrl="http://my.server.de:...html?display=default&count=100" linkPageUrl="http://my.server.de:3001/CM/CMLinkEditPage/" linkIconUrl="/images/link.gif"> der Code für die Anzeige des Quelltextes (gequotet) </codeForSourceView> </content> </cm-code> </cm-response> |
codeForThumbnail
|
---|
Bedeutung: Liefert die URL, den alternativen Text sowie die Größe und Breite eines Vorschaubildes (Thumbnail). |
Definition: <!ELEMENT codeForThumbnail (%cm.atom;)> <!ATTLIST codeForThumbnail thumbnailPageUrl CDATA #REQUIRED defaultImageUrl CDATA #REQUIRED > Bedeutung der Attribute:
Beispiel: <cm-request...> <content-where> <objectId>5765</objectId> <state>edited</state> </content-where> <content-get> <codeForThumbnail thumbnailPageUrl="http://my.server.de:3001/CM/CMObjectThumbnailPage.jsp" defaultImageUrl="http://my.server.de:3001/CM/Images/image.jpg"/> </content-get> </cm-request> <cm-response...> <cm-code numeric="0" phrase="ok"> <content> <codeForThumbnail thumbnailPageUrl="http://my.server.de:3001/CM/CMObjectThumbnailPage.jsp" defaultImageUrl="http://my.server.de:3001/CM/Images/image.jpg"> <IMG BORDER="0" SRC="http://...Servlet?&pageAction=defaultPageAction&objectId=54076" ALT="Vorschau" WIDTH="48" HEIGHT="48"> </codeForThumbnail> </content> </cm-code> </cm-response> |
contentType
|
---|
Bedeutung: Die Dateiendung des Inhalts, die der Version zugeordnet ist. Für Versionen von Dateien des Typs document und publication gilt: Nur wenn der zur Dateiendung gehörende MIME-Typ text/html ist, wird der Haupttext der Version vom Content Manager verarbeitet, werden also beispielsweise darin enthaltene Links mit der Linkverwaltung abgeglichen. Andernfalls wird der Haupttext als reiner Text behandelt. Siehe auch den Systemkonfigurationseintrag content.mimeTypes im Handbuch zur Systemadministration / Entwicklung. |
Definition: <!ELEMENT contentType (%cm.atom;)> |
displayTitle
|
---|
Bedeutung: Der in der HTML-Benutzerschnittstelle angezeigte Titel der Version (entspricht dem Wert von title ). |
Definition: <!ELEMENT displayTitle (%cm.atom;)> |
editor
|
---|
Bedeutung: Der Anmeldename des Bearbeiters der Version. |
Definition: <!ELEMENT editor (%cm.atom; | %cm.user-get;)*>
|
exportBlob
|
---|
Bedeutung: Der Inhalt zur Version. Je nach Datei, zu der die Version gehört, wird der Blob mittels der zuständigen Layouts in das endgültige Export-Format gebracht. |
Definition: <!ELEMENT exportBlob (%cm.atom;)> <!ATTLIST exportBlob encoding (plain | base64 | stream) #IMPLIED > |
exportBlobForFrame
|
---|
Bedeutung: String-Repräsentation des Blobs für einen bestimmten Frame. Je nach Datei, zu der die Version gehört, wird der Blob mit Hilfe der zuständigen Layouts in das endgültige Export-Format gebracht (für Dateien vom Typ Ordner oder Dokument). |
Definition: <!ELEMENT exportBlobForFrame (%cm.atom;)> <!ATTLIST exportBlobForFrame frame CDATA #REQUIRED > Bedeutung der Attribute:
Beispiel: <cm-request...> <content-where> <id>563</id> </content-where> <content-get> <exportBlobForFrame frame="header"/> </content-get> </cm-request> <cm-response...> <cm-code numeric="0" phrase="ok"> <content> <exportBlobForFrame frame="header"> Die String-Repräsentation des Blobs </exportBlobForFrame> </content> </cm-code> </cm-response> |
exportFiles
|
---|
Bedeutung: Eine Liste, die für jede beim Export der Version erzeugte Datei ein Wertepaar enthält. Der erste Wert des Paars ist der Dateiname (ohne Pfad), der zweite Wert ist der zu dieser Datei gehörende Inhalt. |
Definition: <!ELEMENT exportFiles (listitem)*> <!ELEMENT listitem (%cm.atom; | listitem | dictitem)*> <!ELEMENT dictitem (key, value)> <!ELEMENT key (%cm.atom;)> <!ELEMENT value (%cm.atom; | listitem | dictitem)*> |
externalAttributes
|
---|
Bedeutung: Die Liste der Namen und Werte aller zusaätzlichen (kundenspezifischen) Felder, die der Version zugeordnet sind. |
Definition: <!ELEMENT externalAttributes (dictitem)*> <!ELEMENT dictitem (key, value)> <!ELEMENT key (%cm.atom;)> <!ELEMENT value (%cm.atom; | listitem | dictitem)*> |
externalAttrNames
|
---|
Bedeutung: Die Liste der Namen aller kundenspezifischen Felder, die der Version zugeordnet sind. Die Liste wird über die Vorlage der Datei ermittelt, der die Version zugeordnet ist. |
Definition: <!ELEMENT externalAttrNames ((attribute)* | (listitem)*)> <!ELEMENT attribute (%cm.atom; | %cm.attribute-get;)*> <!ELEMENT listitem (%cm.atom; | listitem | dictitem)*> <!ELEMENT dictitem (key, value)> <!ELEMENT key (%cm.atom;)> <!ELEMENT value (%cm.atom; | listitem | dictitem)*>
|
frameNames
|
---|
Bedeutung: Die Liste der Namen aller beim Export der Version entstehenden Frames. |
Definition: <!ELEMENT frameNames (listitem)*> <!ELEMENT listitem (%cm.atom; | listitem | dictitem)*> <!ELEMENT dictitem (key, value)> <!ELEMENT key (%cm.atom;)> <!ELEMENT value (%cm.atom; | listitem | dictitem)*> |
freeLinks
|
---|
Bedeutung: Die Liste der IDs aller in der Version enthaltenen freien Links. |
Definition: <!ELEMENT freeLinks ((link)* | (listitem)*)> <!ELEMENT link (%cm.link-get;)> <!ELEMENT listitem (%cm.atom; | listitem | dictitem)*> <!ELEMENT dictitem (key, value)> <!ELEMENT key (%cm.atom;)> <!ELEMENT value (%cm.atom; | listitem | dictitem)*>
|
getKeys
|
---|
Bedeutung: Die Liste der mit content-get abfragbaren Versionsfelder. |
Definition: <!ELEMENT getKeys (listitem)*> <!ELEMENT listitem (%cm.atom; | listitem | dictitem)*> <!ELEMENT dictitem (key, value)> <!ELEMENT key (%cm.atom;)> <!ELEMENT value (%cm.atom; | listitem | dictitem)*> |
hasThumbnail
|
---|
Bedeutung: Gibt an, ob die Version ein Thumbnail hat. |
Definition: <!ELEMENT hasThumbnail (%cm.atom;)> |
height
|
---|
Bedeutung: Die Höhe des Bildes bei Versionen, die zu Dateien vom Typ image gehören, sofern das Bild eines der unterstützen Formate (GIF, JPG, PNG) hat, andernfalls 0. |
Definition: <!ELEMENT height (%cm.atom;)> |
id
|
---|
Bedeutung: Die ID der Version. |
Definition: <!ELEMENT id (%cm.atom;)> |
isCommitted
|
---|
Bedeutung: Gibt an, ob es sich um eine eingereichte Version handelt. |
Definition: <!ELEMENT isCommitted (%cm.atom;)> |
isComplete
|
---|
Bedeutung: Gibt an, ob die Version vollständig ist. |
Definition: <!ELEMENT isComplete (%cm.atom;)> |
isEdited
|
---|
Bedeutung: Gibt an, ob es sich um eine Arbeitsversion handelt. |
Definition: <!ELEMENT isEdited (%cm.atom;)> |
isReleased
|
---|
Bedeutung: Gibt an, ob es sich um eine freigebene Version handelt. |
Definition: <!ELEMENT isReleased (%cm.atom;)> |
lastChanged
|
---|
Bedeutung: Das Datum der letzten Änderung der Version. |
Definition: <!ENTITY % cm.date " (%cm.atom; | isoDateTime | systemConfigFormattedTime | userConfigFormattedTime)*"> <!ELEMENT lastChanged (%cm.date;)> <!ATTLIST lastChanged type CDATA #IMPLIED> Bedeutung der Attribute:
Beispiel: <cm-request...> <content-where> <id>123</id> </content-where> <content-get> <lastChanged type="date"/> </content-get> </cm-request> <cm-response...> <cm-code numeric="0" phrase="ok"> <content> <lastChanged type="date"> <isoDateTime>20011212141420</isoDateTime> <systemConfigFormattedTime>12.12.2001 14:14 MET</systemConfigFormattedTime> <userConfigFormattedTime>12.12.2001 08:14 EST</userConfigFormattedTime> </lastChanged> </content> </cm-code> </cm-response> |
linkListAttributes
|
---|
Bedeutung: Die Liste der Namen der Felder vom Typ linklist , die der Version zugeordnet sind. |
Definition: <!ELEMENT linkListAttributes ((attribute)* | (listitem)*)> <!ELEMENT attribute (%cm.atom; | %cm.attribute-get;)*> <!ELEMENT listitem (%cm.atom; | listitem | dictitem)*> <!ELEMENT dictitem (key, value)> <!ELEMENT key (%cm.atom;)> <!ELEMENT value (%cm.atom; | listitem | dictitem)*>
|
mimeType
|
---|
Bedeutung: Gibt an, welche Namenserweiterungen zulässig sind, wenn eine Datei als Haupttext einer Version importiert wird. Die erlaubten Dateiendungen sind vom Typ der Datei abhängig, zu der die Version gehört. |
Definition: <!ELEMENT mimeType (%cm.atom;)> |
nextEditGroup
|
---|
Bedeutung: Der Name der nächsten Gruppe im Bearbeitungsworkflow. |
Definition: <!ELEMENT nextEditGroup (%cm.atom; | %cm.group-get;)*>
|
nextSignGroup
|
---|
Bedeutung: Der Name der nächsten Gruppe im Prüfungsworkflow. |
Definition: <!ELEMENT nextSignGroup (%cm.atom; | %cm.group-get;)*>
|
objectId
|
---|
Bedeutung: Die ID der zur Version gehörenden Datei. |
Definition: <!ELEMENT objectId (%cm.atom; | %cm.obj-get;)*>
|
reasonsForIncompleteState
|
---|
Bedeutung: Die Liste der Gründe, aus denen eine Arbeitsversion unvollständig ist. |
Definition: <!ELEMENT reasonsForIncompleteState (listitem)*> <!ELEMENT listitem (%cm.atom; | listitem | dictitem)*> <!ELEMENT dictitem (key, value)> <!ELEMENT key (%cm.atom;)> <!ELEMENT value (%cm.atom; | listitem | dictitem)*> |
setKeys
|
---|
Bedeutung: Die Liste der mit content-set setzbaren Versionsfelder. |
Definition: <!ELEMENT setKeys (listitem)*> <!ELEMENT listitem (%cm.atom; | listitem | dictitem)*> <!ELEMENT dictitem (key, value)> <!ELEMENT key (%cm.atom;)> <!ELEMENT value (%cm.atom; | listitem | dictitem)*> |
signatureAttributes
|
---|
Bedeutung: Die Liste der Namen und Werte der Unterschriftsfelder, die der Version zugeordnet sind. Die Liste wird aus dem Workflow der zur Version gehörenden Datei ermittelt. |
Definition: <!ELEMENT signatureAttributes (namevalue)*> <!ELEMENT namevalue (name, value)> <!ELEMENT name (%cm.atom;)> <!ELEMENT value (%cm.atom; | listitem | dictitem)*> |
signatureAttrNames
|
---|
Bedeutung: Die Liste der Namen der Unterschriftenfelder, die der Version zugeordnet sind. Die Liste wird aus dem Workflow der zur Version gehörenden Datei ermittelt. |
Definition: <!ELEMENT signatureAttrNames ((attribute)* | (listitem)*)> <!ELEMENT attribute (%cm.atom; | %cm.attribute-get;)*> <!ELEMENT listitem (%cm.atom; | listitem | dictitem)*> <!ELEMENT dictitem (key, value)> <!ELEMENT key (%cm.atom;)> <!ELEMENT value (%cm.atom; | listitem | dictitem)*>
|
sortKey1
|
---|
Bedeutung: Erste Sortierschlüsselkomponente (nur bei Ordnern setzbar). |
Definition: <!ELEMENT sortKey1 (%cm.atom;)> |
sortKey2
|
---|
Bedeutung: Zweite Sortierschlüsselkomponente (nur bei Ordnern setzbar). |
Definition: <!ELEMENT sortKey2 (%cm.atom;)> |
sortKey3
|
---|
Bedeutung: Dritte Sortierschlüsselkomponente (nur bei Ordnern setzbar). |
Definition: <!ELEMENT sortKey3 (%cm.atom;)> |
sortKeyLength1
|
---|
Bedeutung: Anzahl der signifikanten Zeichen der ersten Sortierschlüsselkomponente (nur bei Ordnern setzbar). |
Definition: <!ELEMENT sortKeyLength1 (%cm.atom;)> |
sortKeyLength2
|
---|
Bedeutung: Anzahl der signifikanten Zeichen der zweiten Sortierschlüsselkomponente (nur bei Ordnern setzbar). |
Definition: <!ELEMENT sortKeyLength2 (%cm.atom;)> |
sortKeyLength3
|
---|
Bedeutung: Anzahl der signifikanten Zeichen der dritten Sortierschlüsselkomponente (nur bei Ordnern setzbar). |
Definition: <!ELEMENT sortKeyLength3 (%cm.atom;)> |
sortOrder
|
---|
Bedeutung: Sortierrichtung (nur bei Ordnern). |
Definition: <!ELEMENT sortOrder (%cm.atom;)> |
sortType1
|
---|
Bedeutung: Sortiermodus der ersten Sortierschlüsselkomponente (nur bei Ordnern). |
Definition: <!ELEMENT sortType1 (%cm.atom;)> |
sortType2
|
---|
Bedeutung: Sortiermodus der zweiten Sortierschlüsselkomponente (nur bei Ordnern). |
Definition: <!ELEMENT sortType2 (%cm.atom;)> |
sortType3
|
---|
Bedeutung: Sortiermodus der dritten Sortierschlüsselkomponente (nur bei Ordnern). |
Definition: <!ELEMENT sortType3 (%cm.atom;)> |
subLinks
|
---|
Bedeutung: Die Liste der IDs der in der Version vorkommenden Links. |
Definition: <!ELEMENT subLinks ((link)* | (listitem)*)> <!ELEMENT link (%cm.link-get;)> <!ELEMENT listitem (%cm.atom; | listitem | dictitem)*> <!ELEMENT dictitem (key, value)> <!ELEMENT key (%cm.atom;)> <!ELEMENT value (%cm.atom; | listitem | dictitem)*>
|
thumbnail
|
---|
Bedeutung: Ein base-64-kodiertes Vorschaubild im JPEG-Format (siehe auch das Handbuch zur Systemadministration / Entwicklung). Nur verfügbar bei Dateien vom Typ image und generic . |
Definition: <!ELEMENT thumbnail (%cm.atom;)> |
title
|
---|
Bedeutung: Der Titel der Version. |
Definition: <!ELEMENT title (%cm.atom;)> <!ATTLIST title lang (en | de | it | fr | es) #IMPLIED> Bedeutung der Attribute:
Beispiel: <cm-request...> <content-where> <id>123</id> </content-where> <content-get> <title lang="en"/> </content-get></cm-request> <cm-response...> <cm-code numeric="0" phrase="ok"> <content> <title lang="en">summer and winter</title> </content> </cm-code> </cm-response> |
validFrom
|
---|
Bedeutung: Das Datum des Beginns der Gültigkeit der Version. Bei Layouts wird dieser Wert ignoriert. |
Definition: <!ENTITY % cm.date " (%cm.atom; | isoDateTime | systemConfigFormattedTime | userConfigFormattedTime)*"> <!ELEMENT validFrom (%cm.date;)> <!ATTLIST validFrom type CDATA #IMPLIED> Bedeutung der Attribute:
Beispiel: <cm-request...> <content-where> <objectId>32875</objectId> <state>edited</state> </content-where> <content-get> <validFrom type="date"/> </content-get></cm-request> <cm-response...> <cm-code numeric="0" phrase="ok"> <content> <validFrom type="date"> <isoDateTime>20010401121207</isoDateTime> <systemConfigFormattedTime>01.04.2001 12:12 MET</systemConfigFormattedTime> <userConfigFormattedTime>01.04.2001 06:12 EST</userConfigFormattedTime> </validFrom> </content> </cm-code> </cm-response> |
validSortKeys
|
---|
Bedeutung: Die Liste aller gültigen Werte für die Felder sortKeyn
. |
Definition: <!ELEMENT validSortKeys (listitem)*> <!ELEMENT listitem (%cm.atom; | listitem | dictitem)*> <!ELEMENT dictitem (key, value)> <!ELEMENT key (%cm.atom;)> <!ELEMENT value (%cm.atom; | listitem | dictitem)*> |
validSortOrders
|
---|
Bedeutung: Die Liste aller gültigen Werte für das Feld sortOrder . |
Definition: <!ELEMENT validSortOrders (listitem)*> <!ELEMENT listitem (%cm.atom; | listitem | dictitem)*> <!ELEMENT dictitem (key, value)> <!ELEMENT key (%cm.atom;)> <!ELEMENT value (%cm.atom; | listitem | dictitem)*> |
validSortTypes
|
---|
Bedeutung: Die Liste aller gültigen Werte für die Felder sortTypen
. |
Definition: <!ELEMENT validSortTypes (listitem)*> <!ELEMENT listitem (%cm.atom; | listitem | dictitem)*> <!ELEMENT dictitem (key, value)> <!ELEMENT key (%cm.atom;)> <!ELEMENT value (%cm.atom; | listitem | dictitem)*> |
validUntil
|
---|
Bedeutung: Das Datum des Endes der Gültigkeit der Version. Bei Layouts wird dieser Wert ignoriert. |
Definition: <!ENTITY % cm.date " (%cm.atom; | isoDateTime | systemConfigFormattedTime | userConfigFormattedTime)*"> <!ELEMENT validUntil (%cm.date;)> <!ATTLIST validUntil type CDATA #IMPLIED> Bedeutung der Attribute:
Beispiel: <cm-request...> <content-where> <id>3287.5</id> </content-where> <content-get> <validUntil type="date"/> </content-get></cm-request> <cm-response...> <cm-code numeric="0" phrase="ok"> <content> <validUntil type="date"> <isoDateTime>20051231060002</isoDateTime> <systemConfigFormattedTime>31.12.2005 06:00 MET</systemConfigFormattedTime> <userConfigFormattedTime>30.12.2005 00:00 EST</userConfigFormattedTime> </validUntil> </content> </cm-code> </cm-response> |
width
|
---|
Bedeutung: Die Breite des Bildes bei Versionen, die zu Dateien vom Typ image gehören, sofern das Bild eines der unterstützen Formate (GIF, JPG, PNG) hat, andernfalls 0. |
Definition: <!ELEMENT width (%cm.atom;)> |
workflowComment
|
---|
Bedeutung: Der Kommentar zu der letzten Workflow-Aktion, die auf diese Version angewendet wurde. |
Definition: <!ELEMENT workflowComment (%cm.atom;)> |
xmlBlob
|
---|
Bedeutung: String-Repräsentation des Blobs der Version als XML-Dokument (nicht verfügbar bei Layouts). |
Definition: <!ELEMENT xmlBlob (%cm.atom;)> |