Provides interfaces for creating, modifying, managing, and retrieving
Data Entry Templates (See
Data Entry Template Example).
Refer to the Administrator Guide for Content Server for
additional details on Content Data Entry Template functionality, or see
Plumtree Developer Center
for developer discussions and additional documentation.
Note: Data Entry Template names cannot be an empty string,
cannot be longer than 255 characters and are case-insensitive.
The steps below describe common interactions between different Content
Server objects.
1. Create a Data Entry Template.
2. Add one or more Content Server properties to the Data Entry Template and store the template.
3. Create a Presentation Template for the Data Entry Template.
4. Attach the Presentation Template to the Data Entry Template and store the Data Entry Template.
5. Create one or more content items using the Data Entry Template.
6. Set values for properties on the content item and check-in the content item.
7. Preview and publish the content item.
Note: One or more content items can be created using the same Data Entry Template; however,
only one Presentation Template can be attached to a Data Entry Template.
Since EDK 5.2
Namespace hierarchy
Interfaces
| Interface | Description |
|---|
| IDataEntryTemplate |
IDataEntryTemplate represents a Data Entry Template in the Content Server. It defines a set of properties needed for creating and publishing an IContentItem. All properties that can be added to a Data Entry Template are sub-types of IBaseProperty. To properly define a Data Entry Template use IDataEntryTemplateManager.CreateDataEntryTemplate to create a new template and add one or more properties to the template using IDataEntryTemplate.AddProperty. A newly-created Data Entry Template or any property modification to an existing Data Entry Template will not be permanently stored until IDataEntryTemplate.Store is called.
The following example code shows how to create a Data Entry Template, add properties of different types, attach an existing PresentationTemplate to the template, and finally persist the Data Entry Template.
// Create a DET object.
IDataEntryTemplate det = detManager.CreateDataEntryTemplate(folder, "My Data Entry Template");
// Add an integer property.
IIntegerProperty intProp = propertyManager.CreateIntegerProperty("Integer Prop", "Description for intProp");
det.AddProperty(intProp);
// Add a boolean property
IBooleanProperty boolProp = propertyManager.CreateBooleanProperty("Boolean Prop", "Description for boolProp");
det.AddProperty(boolProp);
// Add a float property.
IDoubleProperty doubleProp = propertyManager.CreateDoubleProperty("Double Prop", "Description for doubleProp");
det.AddProperty(doubleProp);
// Add a date property.
IDateProperty dateProp = propertyManager.CreateDateProperty("Date Prop", "Description for dateProp");
det.AddProperty(dateProp);
// Add a text line property.
// Text lines are brief strings without newline characters.
// Use the text block property for storing longer strings.
ITextLineProperty textLineProp = propertyManager.CreateTextLineProperty("TextLine Prop", "Description for textLineProp");
det.AddProperty(textLineProp);
// Add an item reference property.
// An item reference links to another content item. The
// content item does not have to be associated with the same DET.
//
// Not shown is the item collection property. It is
// similar to the item reference property, but links to
// multiple content items.
IItemReferenceProperty itemRefProp = propertyManager.CreateItemReferenceProperty("Item Reference Prop", "Description for itemRefProp");
det.AddProperty(itemRefProp);
// Add a selection list property.
// A selection list is a defined set of choices of which
// one may be selected. This can be visualized as a
// drop down box.
String[] listValues = { "Portal", "Search Server", "Collaboration Server", "Content Server", "Analytics" };
ISelectionList selectionList = slManager.CreateSelectionList(folder, "Products Selection List", listValues);
selectionList.Store();
ISelectionListProperty selectionListProp = propertyManager.CreateSelectionListProperty("Selection List Prop", "Description for SelectionListProp", selectionList);
det.AddProperty(selectionListProp);
// Add a text block property.
// Text block properties are used to store long strings
// that can span many lines. For short strings contained
// on only one line, use the text line property instead.
ITextBlockProperty textBlockProp = propertyManager.CreateTextBlockProperty("Text Block Prop", "Description for textBlockProp");
det.AddProperty(textBlockProp);
// Add a file property.
IFileProperty log = propertyManager.CreateFileProperty("Log File", "A log file taken while the problem occurred.");
det.AddProperty(log);
// Add an image property.
IImageProperty screenShot = propertyManager.CreateImageProperty("Screen Shot", "A screen shot of the problem.");
det.AddProperty(screenShot);
// Attach an existing Presentation Template
det.AttachPresentationTemplate(storedPresentationTemplate);
// Actually store the DET with the attached Presentation Template and all the properties associated with it.
det.Store();
A persisted Data Entry Template is needed to create a content item, otherwise an InvalidOperationException will be thrown when IContentItemManager.CheckInItem is called. To publish a content item, AttachPresentationTemplate is required to call with a IPresentationTemplate with valid template text set, otherwise an InvalidOperationException will be thrown.
|
| IDataEntryTemplateManager |
IDataEntryTemplateManager is an interface for managing IDataEntryTemplates. It handles Data Entry Template creation, removal, and retrieval. A newly-created Data Entry Template or any property modification to an existing Data Entry Template will not be permanently stored until IDataEntryTemplate.Store is called. Refer to the Administrator Guide for Content Server for additional details on Data Entry Template functionality. |