Content Management Guide  

Chapter 8   Content Management Tag Library

This chapter provides reference documentation for the tags in the Content Management tag library (ContentMgmtTag.jar):

 
Top of page

checkIn

Checks a document in to the Content Management subsystem for the current user and saves a new content version. If the save is successful, the tag returns an integer representing the new version.

This tag wraps the checkinDocument() method on the EbiContentMgmtDelegate interface.

 
Top of section

Syntax

  <prefix:checkIn docid="docID" mime="mime" content="content" comment="comment" keepcheckedout="keepcheckedout" id="ID" />

Attribute

Required?

Request-time expression values supported?

Description

docid

Yes

Yes

Specifies the UUID for a document in the Content Management subsystem.

mime

Yes

Yes

Specifies the MIME type of the new version.

content

Yes

Yes

Specifies the new content data.

comment

No

Yes

Specifies a checkin comment.

keepcheckedout

Yes

Yes

Indicates whether the new version should be kept checked out.

If true, the new version is inserted but the document remains checked out to the user.

If false, the lock is released and the document is made available for changes by other users.

id

No

No

Specifies the name of the variable used to store the result of the operation. If the checkin is successful, this variable holds the new version.

If no value is specified, a default id of version is used.

 
Top of section

Example

  <% taglib uri="/cm" prefix="cm" %>
  ...
  <% 
  String content = "this is my new content";
  byte myarray[] = content.getBytes();
  %>
  ...
  <cm:checkIn docid="addd2545931b11d48e130010a4e70c5f" id="version" comment="checking in my changes" content="<%=myarray%>" keepcheckedout="true" mime="text/html" />
  <%=pageContext.getAttribute("version")%>

 
Top of page

checkOut

Checks out a document for the current user, returning true if successful and false if unsuccessful.

This tag wraps the checkoutDocument() method on the EbiContentMgmtDelegate interface.

 
Top of section

Syntax

  <prefix:checkOut docid="docID" id="ID" />

Attribute

Required?

Request-time expression values supported?

Description

docid

Yes

Yes

Specifies the UUID for a document in the Content Management subsystem.

id

No

No

Specifies the name of the variable that is used to store the result of the operation.

If no value is specified, a default id of checkout is used.

 
Top of section

Example

  <% taglib uri="/cm" prefix="cm" %>
  ...
  <cm:checkOut docid="addd2545931b11d48e130010a4e70c5f" id="result" />
  <%=pageContext.getAttribute("result")%>

 
Top of page

findDocuments

Retrieves documents that match the criteria specified in tag attributes (as described below), returning either a list of EbiDocument objects or an XML string.

This tag wraps either the findElements() or the findFilteredElements() method of the EbiContentMgmtDelegate interface.

 
Top of section

Syntax

  <prefix:findDocuments id="ID" secure="securitySetting" xml="xmlFormat" authorFrom="authorFrom" authorTo="authorTo" authorLike="authorLike" categoryID="categoryID" createDateFrom="createDateFrom" createDateTo="createDateTo" expireDateFrom="expireDateFrom" expireDateTo="expireDateTo" publishDateFrom="publishDateFrom" publishDateTo="publishDateTo" docTypeName="docTypeName" folderID="folderID" docNameFrom="docNameFrom" docNameTo="docNameTo" docNameLike="docNameLike" parentDocId="parentDocID" titleFrom="titleFrom" titleTo="titleTo" titleLike="titleLike" orderAsc="orderAsc" orderDesc="orderDesc"/>

Attribute

Required?

Request-time expression values supported?

Description

id

No

No

Specifies the name of the variable used to store the list of EbiDocument objects.

If no value is specified, a default id of foundDocuments is used.

secure

No

No

Specifies whether the returned documents are filtered according to security constraints.

If true (the default), the filter method is used and only those documents to which the user has read access are returned.

If false, all documents are returned.

xml

No

No

Specifies that the document list is returned as an XML string.

The DTD for the returned xml is contentmgmt-query-results_3_0.dtd, which can be found under templates\Director\library\ContentMgmtService/ContentMgmtService-conf/DTD directory in the standard Director installation directory.

If not specified, a list of EbiDocument objects is returned.

authorFrom

authorTo

No

Yes

Search for documents based on a range of author metadata.

authorLike

No

Yes

Search for documents based on a match of author metadata.

This attribute is case-insensitive, and may include SQL wildcard characters % and _.

categoryID

No

Yes

Limits the search to documents in a particular category.

createDateFrom

createDateTo

No

Yes

Search for documents based on creation date metadata.

Date entries should have the format m/d/yyyy. For example: 5/14/2001 is a valid date entry.

expireDateFrom

expireDateTo

No

Yes

Search for documents based on expiration date metadata.

Date entries should have the format m/d/yyyy. For example: 5/14/2001 is a valid date entry.

publishDateFrom

publishDateTo

No

Yes

Search for documents based on publication date metadata.

Date entries should have the format m/d/yyyy. For example: 5/14/2001 is a valid date entry.

docTypeName

No

Yes

Limits the search to documents of a specific type.

folderId

No

Yes

Limits the search to documents in a particular folder.

docNameFrom

docNameTo

No

Yes

Search for documents based on a range of document name metadata.

docNameLike

No

Yes

Search for documents based on a match of document name metadata.

This attribute is case-insensitive, and may include SQL wildcard characters % and _.

parentDocId

No

Yes

Limits the search to documents that are children of a particular document.

titleFrom

titleTo

No

Yes

Search for documents based on a range of title metadata.

titleLike

No

Yes

Search for documents based on a match of title metadata.

This attribute is case-insensitive, and may include SQL wildcard characters % and _.

orderAsc

orderDesc

No

Yes

Sorts the documents in ascending or descending order, based on one of the search criteria.

Legitimate values for these attributes are:

  • author

  • createDate

  • docId

  • docName

  • expireDate

  • publishDate

  • title

 
Top of section

Example

  <cm:findDocuments id="test2" secure="false" xml="false"
  	 	 authorLike="administrator" orderAsc="DOCID" />
  Found <%=test2.size()%> Documents <br/>
  <% for (int x=0;x<test2.size();x++){
  
  	 	 EbiDocument doc = (EbiDocument) test2.get(x); %>
  	 	 Doc <%=x%> title = <%=doc.getTitle()%>
  
  <% } %>

 
Top of page

getChildDocuments

Retrieves the children of a document, returning a list of EbiDocument objects.

Depending on the setting for the secure attribute, this tag wraps either the getChildDocuments() or the getFilteredChildDocuments() method on the EbiContentMgmtDelegate interface.

 
Top of section

Syntax

  <prefix:getChildDocuments docid="docID" docpath="docPath" id="ID" secure="securitySetting"/>

Attribute

Required?

Request-time expression values supported?

Description

docid

No

Yes

Specifies the UUID for the parent document in the Content Management subsystem.

If you do not specify a docid value, you must specify a value for the docpath attribute.

docpath

No

Yes

Specifies the path to the parent document in the Content Management subsystem.

If you do not specify a docpath value, you must specify a value for the docid attribute.

id

No

No

Specifies the name of the variable used to store the returned list of EbiDocument objects.

If no value is specified, a default id of childDocuments is used.

secure

No

No

Specifies whether the returned documents are filtered according to security constraints.

If true (the default), the filter method is used and only those documents to which the user has read access are returned.

If false, all documents are returned.

 
Top of section

Example

  <cm:getChildDocuments docid="c373e9ea8d110d2c8f6a0000864ec468" id="test3"/>
  Found <%=test3.size()%> Child Documents <br/>

 
Top of page

getContent

Retrieves the contents of a document, returning a string.

This tag wraps the getContent() method on the EbiContentMgmtDelegate interface.

 
Top of section

Syntax

  <prefix:getContent docid="docID" docpath="docpath" id="ID" version="version" verid="verID" />

Attribute

Required?

Request-time expression values supported?

Description

docid

No

Yes

Specifies the UUID for a document in the Content Management subsystem.

If a docid value is not specified, you must specify a value for the docpath attribute.

docpath

No

Yes

Specifies the path to a document in the Content Management subsystem.

If a docpath value is not specified, you must specify a value for the docid attribute.

id

No

No

Specifies the name of the variable used to store the EbiDocContent object.

If no value is specified, the document content is inserted in the page at the location where the tag appears.

version

No

No

Indicates whether to return the latest version of the content.

If true:

  • And you specify a version using the verid attribute, that version of the content is returned.

  • And verid is not specified, the latest version of the content is returned.

If false (the default), the published version of the content is returned. If no version is published, no content is returned.

verid

No

Yes

Specifies a version ID for the content that should be returned.

If the version attribute is false, the verid attribute is ignored.

 
Top of section

Example

This example gets the latest version of the content for a particular document by specifying the path to the document. The document content is inserted in the page at the location where the getContent tag appears.

  <% taglib uri="/cm" prefix="cm" %>
  ...
  <cm:getContent docpath="HR/Employee Forms/ESPP/ChangeOfAddress.html" version="true" />
  ...

 
Top of page

getDirectory

Retrieves a directory from the Content Management subsystem, returning an EbiDirectory object. This tag can be used to retrieve folders as well as categories.

This tag wraps the getEntry() and lookupDirectoryEntry() methods on the EbiContentMgmtDelegate interface.

 
Top of section

Syntax

  <prefix:getDirectory id="id" roottype="roottype" dirname="dirname" dirid="dirid" dirpath="dirpath" />

Attribute

Required?

Request-time expression values supported?

Description

id

No

No

Specifies the name of the variable used to store the EbiDirectory object.

If no value is specified, the default name of dirEntry is used for the variable.

roottype

Yes

Yes

Specifies whether the tag is being used to retrieve a folder or a category.

If the directory is a folder, specify folder as the value for the roottype attribute. If it is a category, specify category instead.

Typically, this attribute is used in conjunction with one of the following attributes to specify the correct directory object in the Content Management subsystem:

  • dirname

  • dirid

  • dirpath

If none of these attributes is specified, the root folder or category is returned, depending on the setting of roottype.

dirname

No

Yes

Specifies the name of the directory you want to retrieve.

The directory specified must be a direct descendent of the root.

The directory can be a folder or category in the Content Management subsystem.

dirid

No

Yes

Specifies the UUID for the directory you want to retrieve.

The directory can be a folder or category in the Content Management subsystem.

dirpath

No

Yes

Specifies the path to the directory you want to retrieve.

The directory can be a folder or category in the Content Management subsystem.

 
Top of section

Example

  <%@ taglib uri="/cm" prefix="cm" %>
  ...
  <cm:getDirectory roottype="category" dirpath="HR/Employee Forms/ESPP" >
  
  ID for the directory is ...
  <%=dirEntry.getID()%>

 
Top of page

getDirectoryList

Retrieves a list of directory contents from the Content Management subsystem, returning a collection of EbiDirectoryEntry objects. Depending on the attributes specified, this collection can contain folder, category, and document objects.

This tag wraps the getDirectoryList() and getFilteredDirectoryList() methods on the EbiContentMgmtDelegate interface.

 
Top of section

Syntax

  <prefix:getDirectoryList id="id" finddocuments="finddocuments" roottype="roottype" parentdir="parentdir" iterate="iterate" findsubdirs="findsubdirs" dirname="dirname" dirid="dirid" dirpath="dirpath" filter="documents" />

Attribute

Required?

Request-time expression values supported?

Description

id

No

No

Specifies the name of the variable used to store the Collection object.

If a value is specified for the id attribute, that value is used as the name for the resulting variable that contains the collection. Otherwise, the default name of dirList is used for the variable.

finddocuments

No

No

Indicates whether to retrieve the documents that are located in the specified directory.

If true, all documents located in the specified directory are retrieved.

If false (the default), documents located in the specified directory are not retrieved.

roottype

No

Yes

Specifies whether to retrieve the contents of a folder or a category. If the directory is a folder, specify folder as the value for the root attribute. If it's a category, specify category.

Typically, this attribute is used in conjunction with one of the following attributes:

  • dirname

  • dirid

  • dirpath

If the roottype attribute is specified by itself, the directory for which contents will be retrieved is the root.

If a value for this attribute is not specified, the directory for which contents will be retrieved is assumed to be the root folder.

parentdir

No

Yes

Specifies the directory object for which the document contents should be retrieved. The object should be of type EbiDirectory.

If this attribute is specified, it is not necessary to specify the roottype attribute.

iterate

No

No

Indicates whether this tag operates as a body tag so that each row can be processed separately.

If true, the following values can be accessed within the getDirectoryList tag:

  • identifier

  • name

  • type

  • isdir

Each of these variables has a scope of NESTED.

If false (the default), this tag operates as a nonbody tag. The tag returns an object of type Collection that contains a collection of EbiDirectoryEntry objects.

findsubdirs

No

No

Indicates whether to retrieve directories that are child directories under the specified one.

If true (the default), all subdirectories of the specified directory are retrieved.

If false, subdirectories of the specified directory are not retrieved.

dirname

No

Yes

Specifies the name of a directory from which contents should be retrieved.

The directory specified must be a direct descendent of the root.

The directory can be a folder or category in the Content Management subsystem.

dirid

No

Yes

Specifies the UUID for a directory from which contents should be retrieved.

The directory can be a folder or category in the Content Management subsystem.

dirpath

No

Yes

Specifies the path to a directory from which contents should be retrieved.

The directory can be a folder or category in the Content Management subsystem.

filter

No

No

Indicates whether to search using security filters.

If true (the default), the filter method is used and only those objects to which the user has read access are returned.

If false, all objects are returned.

 
Top of section

Example 1

This example shows how to use the getDirectoryList tag with the iterate attribute set to true:

  <%@ taglib uri="/cm" prefix="cm" %>
  ...
  <cm:getDirectoryList roottype="category" dirpath="HR/Employee Forms/ESPP" finddocuments="true" iterate="true">
  Identifier = <%=identifier%><br/>
  Name = <%=name%><br/>
  Type = <%=type%><br/>
  Is this item a directory? = <%=isdir%><br/>
  </cm:getDirectoryList>

 
Top of section

Example 2

This example shows how to use the getDirectoryList tag with the iterate attribute set to false:

  <%@ taglib uri="/cm" prefix="cm" %>
  ...
  <cm:getDirectoryList iterate="false" filter="false"/>
  
  <%= ((java.util.List)pageContext.getAttribute("dirList")).size() %> = the size of the list...

 
Top of page

getDocType

Retrieves a document type from the Content Management subsystem, returning an EbiDocType object.

Depending on whether you specify the typeid or name attribute, this tag wraps the getDocumentTypeByID() or getDocumentTypeByName() method on the EbiContentMgmtDelegate interface.

 
Top of section

Syntax

  <prefix:getDocType typeid="docID" name="name" id="ID" />

Attribute

Required?

Request-time expression values supported?

Description

typeid

No

Yes

Specifies the UUID for a document type in the Content Management subsystem.

If you do not specify a typeid value, you must specify a value for the name attribute.

name

No

Yes

Specifies the name of a document type in the Content Management subsystem.

If you do not specify a name value, you must specify a value for the typeid attribute.

id

No

No

Specifies the name of the variable used to store the EbiDocType object.

If no value is specified, a default id of docType is used.

 
Top of section

Example

  <% taglib uri="/cm" prefix="cm" %>
  ...
  <cm:getDocType typeid="addd2543931b11d48e130010a4e70c5f" id="test" />
  ...
  Name for the doc type is ...
  <%=test.getDocTypeName()%>

 
Top of page

getDocument

Retrieves a document, returning an EbiDocument object.

This tag wraps the getDocument() method on the EbiContentMgmtDelegate interface.

 
Top of section

Syntax

  <prefix:getDocument docid="docID" docpath="docPath" id="ID" />

Attribute

Required?

Request-time expression values supported?

Description

docid

No

Yes

Specifies the UUID for a document in the Content Management subsystem.

If you do not specify a docid value, you must specify a value for the docpath attribute.

docpath

No

Yes

Specifies the path to a document in the Content Management subsystem.

If you do not specify a docpath value, you must specify a value for the docid attribute.

id

No

No

Specifies the name of the variable used to store the EbiDocument object.

If no value is specified, a default id of document is used.

 
Top of section

Example

  <% taglib uri="/cm" prefix="cm" %>
  ...
  <cm:getDocument id="test" docid="addd2545931b11d48e130010a4e70c5f" />
  Title for document is ...
  <%=test.getTitle()%>

 
Top of page

getFieldInfo

Retrieves the extension fields of a document, returning the field information as an EbiDocExtnMeta object.

This tag wraps the getDocumentExtnMeta() method on the EbiContentMgmtDelegate interface.

 
Top of section

Syntax

  <prefix:getFieldInfo docid="docID" docpath="docPath" id="ID" iterate="iterateSetting"/>

Attribute

Required?

Request-time expression values supported?

Description

docid

No

Yes

Specifies the UUID for a document in the Content Management subsystem.

If you do not specify a docid value, you must specify a value for the docpath attribute.

docpath

No

Yes

Specifies the path to a document in the Content Management subsystem.

If you do not specify a docpath value, you must specify a value for the docid attribute.

id

No

No

Specifies the name of the variable used to store the EbiDocExtnMeta object.

If no value is specified, a default id of docFields is used.

iterate

No

No

Indicates whether this tag operates as a body tag so that each row can be processed separately.

If true, the following values can be accessed within the getDirectoryList tag:

  • fieldInfo

  • fieldName

  • fieldValues

Each of these variables has a scope of NESTED.

If false (the default), this tag operates as a nonbody tag. The tag returns an EbiDocExtnMeta object.

 
Top of section

Example

  <cm:getFieldInfo docid="c373e9ea8d110d2c8f6a0000864ec468" id="test6" />
  <% for (int x=0;x<test6.size();x++){
  
  	 	 EbiDocExtnMetaInfo dmi = (EbiDocExtnMetaInfo) test6.get(x); %>
  	 	 Field <%=x%> info = <%=dmi.getFieldName()%>
  
  <% } %>

 
Top of page

getFields

Retrieves fields from the Content Management subsystem, returning a collection of EbiDocField objects. You can use this tag to retrieve all fields or fields for a given document type.

This tag wraps the getDocumentFields() and getFilteredDocumentFields() methods on the EbiContentMgmtDelegate interface.

 
Top of section

Syntax

  <prefix:getFields id="ID" doctypeid="doctypeID" doctypename="doctypename" iterate="iterate" filter="filter" />

Attribute

Required?

Request-time expression values supported?

Description

id

No

No

Specifies the name of the variable used to store the collection of EbiDocField objects.

If no value is specified, a default name of fieldList is used for the variable.

doctypeid

No

Yes

Specifies the UUID for a document type in the Content Management subsystem.

If you do not specify either a doctypeid or doctypename value, all fields are retrieved.

doctypename

No

Yes

Specifies the name of a document type in the Content Management subsystem.

If you do not specify either a doctypeid or doctypename value, all fields are retrieved.

iterate

No

No

Indicates whether this tag is to operate as a body tag so that each row can be processed separately.

If true, the following values can be accessed within the getFields tag:

  • identifier

  • name

Each of these variables has a scope of NESTED.

If false (the default), this tag operates as a nonbody tag. In this case, the tag returns a collection of EbiDocField objects.

filter

No

No

Indicates whether to search using security filters.

If true (the default), the filter method is used and only those fields to which the user has read access are returned.

If false, all fields are returned.

 
Top of section

Example 1

This example shows how to use the getFields tag with the iterate attribute set to true:

  <%@ taglib uri="/cm" prefix="cm" %>
  ...
  <cm:getFields doctypename="myDocumentType" iterate="true">
  Identifier = <%=identifier%><br/>
  Name = <%=name%><br/>
  </cm:getFields>

 
Top of section

Example 2

This example shows how to use the getFields tag with the iterate attribute set to false:

  <%@ taglib uri="/cm" prefix="cm" %>
  ...
  <cm:getFields iterate="false" filter="false"/>
  
  <%= ((java.util.List)pageContext.getAttribute("fieldList")).size() %> = the size of the list...

 
Top of page

getLinkedDocuments

Retrieves the documents linked to a particular document, returning a list of EbiDocument objects.

Depending on the attributes you specify for this tag, it wraps one of these methods on the EbiContentMgmtDelegate interface:

 
Top of section

Syntax

  <prefix:getLinkedDocuments docid="docID" docpath="docPath" id="ID" secure="securitySetting" parentLinks="parentLinksSetting"/>

Attribute

Required?

Request-time expression values supported?

Description

docid

No

Yes

Specifies the UUID for a document in the Content Management subsystem.

If you do not specify a docid value, you must specify a value for the docpath attribute.

docpath

No

Yes

Specifies the path to a document in the Content Management subsystem.

If you do not specify a docpath value, you must specify a value for the docid attribute.

id

No

No

Specifies the name of the variable used to store the list of EbiDocument objects.

If no value is specified, a default id of linkedDocuments is used.

secure

No

No

Specifies whether the returned documents are filtered according to security constraints.

If true (the default), the filter method is used and only those documents to which the user has read access are returned.

If false, all documents are returned.

parentLinks

No

No

Specifies whether you want to get documents that are linked as parents or children to the specified document.

If true, return parent documents to which this document is linked.

If false (the default), return child documents that are linked to this document.

 
Top of section

Example

  <cm:getLinkedDocuments docid="c373e9ea8d110d2c8f6a0000864ec468"
  	 	 id="test4" parentLinks="false"/>
  Found <%=test4.size()%> Linked Documents <br/>

 
Top of page

getVersionHistory

Retrieves the versions of a document, returning a list of EbiDocVersion objects.

This tag wraps the getDocumentContentVersions() method on the EbiContentMgmtDelegate interface.

 
Top of section

Syntax

  <prefix:getVersionHistory docid="docID" docpath="docPath" id="ID" includeContent="includeContent"/>

Attribute

Required?

Request-time expression values supported?

Description

docid

No

Yes

Specifies the UUID for a document in the Content Management subsystem.

If you do not specify a docid value, you must specify a value for the docpath attribute.

docpath

No

Yes

Specifies the path to a document in the Content Management subsystem.

If you do not specify a docpath value, you must specify a value for the docid attribute.

id

No

No

Specifies the name of the variable used to store the list of EbiDocVersion objects.

If no value is specified, a default id of docVersions is used.

includeContent

No

No

Include the actual content in the returned EbiDocVersion objects.

 
Top of section

Example

  <cm:getVersionHistory docid="c373e9ea8d110d2c8f6a0000864ec468"
  	 	 id="test1" includeContent="false"/>
  <% EbiDocVersion ver = (EbiDocVersion) test1.get(0); %>
  Version mime-type is = <%=ver.getMimeType()%>

 
Top of page

publish

Publishes a specified version of content for a document, returning true if successful or false if unsuccessful.

This tag wraps the publishDocumentContentVersion() method on the EbiContentMgmtDelegate interface.

 
Top of section

Syntax

  <prefix:publish docid="docID" uselatest="uselatest" version="version" overwrite="overwrite" force="force" />

Attribute

Required?

Request-time expression values supported?

Description

docid

Yes

Yes

Specifies the UUID for a document in the Content Management subsystem.

uselatest

Yes

No

Indicates whether to publish the latest version of the document.

If true, the latest version is published.

If false, the version number specified in the version attribute is published.

version

No

Yes

Specifies the version to publish.

This attribute is required if the uselatest attribute is set to false.

overwrite

No

No

Indicates whether to replace any versions already published.

If true (the default), the specified version overwrites any published version for the document.

If false, an exception is thrown if a published version of the document already exists.

force

No

No

Indicates whether to force an immediate publish, regardless of the publish dates specified in the document metadata.

If true, the version is published regardless of the publish date value specified for the document.

If false (the default), the current data and time is compared against the publish date and time specified for the document. If it is too early or too late to publish, the version is not published; otherwise, the version is published. In either case, an application exception is thrown.

 
Top of section

Example

  <% taglib uri="/cm" prefix="cm" %>
  ...
  <cm:publish docid="addd2545931b11d48e130010a4e70c5f" uselatest="true" />

 
Top of page

unCheckOut

Unchecks out a document from the Content Management subsystem for the current user, returning true if successful or false if unsuccessful.

NOTE   No data is saved. Any changes made between the original checkout and the uncheckout are lost.

This tag wraps the unCheckOutDocument() method on the EbiContentMgmtDelegate interface.

 
Top of section

Syntax

  <prefix:unCheckOut docid="docID" id="ID" />

Attribute

Required?

Request-time expression values supported?

Description

docid

Yes

Yes

Specifies the UUID for a document in the Content Management subsystem.

id

No

No

Specifies the name of the variable used to store the result of the operation.

If no value is specified, a default id of uncheckout is used.

 
Top of section

Example

  <% taglib uri="/cm" prefix="cm" %>
  ...
  <cm:unCheckOut docid="addd2545931b11d48e130010a4e70c5f" id="done" />
  <%=pageContext.getAttribute("done")%>

 
Top of page

updateDocument

Updates a document in the Content Management subsystem, returning true if successful or false if unsuccessful.

This tag wraps the updateDocument() method on the EbiContentMgmtDelegate interface.

 
Top of section

Syntax

  <prefix:updateDocument doc="document" checkout="checkoutSetting" checkin="checkinSetting"/>

Attribute

Required?

Request-time expression values supported?

Description

doc

No

Yes

Specifies a document (an object of class EbiDocument) in the Content Management subsystem.

checkout

No

Yes

Specifies that the document is to be checked out to the current user before performing the update.

checkin

No

Yes

Specifies that the document is to be checked in after performing the update.

 
Top of section

Example

  <cm:getDocument id="test" docid="c373e9ea8d110d2c8f6a0000864ec468" />
  ...
  <% test.setAbstract(test.getAbstract()+"a"); %>
  <cm:updateDocument doc="<%=test%>" checkout="true" checkin="true"/>


   

Content Management Guide  

Copyright © 2002, SilverStream Software, Inc. All rights reserved.