Element control element
The element control element is used to populate elements stored in components, site areas and content items.
Element overview
The Web Content Integrator uses the following business logic to process each component element in the feed entry:- It checks whether the component site area or content item contains a field whose name matches the value in the feed element's name attribute. This is a case-sensitive comparison so the names must match exactly.
- If a matching field is found, it checks whether the data type matches what was specified in the feed element's sub-element.
- If both the name and data type match, the element in the site area or content item will be updated to match the data contained the feed element.
- If an element is found which matches the feed element's name, but not its data type, the Web Content Integrator will remove the old field from the site area or content item and attempt to replace it with a new field that matches the data type specified in the feed.
- If no matching field can be found on the content, the Web Content Integrator will attempt to create a new element.
Note: When creating elements in Web Content Manager using an authoring
portlet, it is possible to specify a number of field validation criteria
such as the maximum size of a text field or the allowable range of
a date field. These are validated during the save operation. If the
data in the field does not meet the validation criteria the entire
save operation will fail, meaning that none of the changes in the
feed entry will be applied. The Web Content Integrator does not have
the ability to check that the data in the feed element is valid prior
to attempting the save operation. Therefore, if you elect to implement
validations on your authoring templates, it is important for the feed
producer to insure that the content is valid during the generation
of the feed.
Text element
Element parameters: | Details for this element: |
---|---|
Applies to item types | Site areas and content items |
Required for item types | None. |
Allowable Values | A text component should contain a plain text value. |
Required Attributes |
|
Optional Attributes | None |
Required sub-elements |
|
Optional sub-elements | None |
Example:
<ibmwcm:element name="Headline"> <ibmwcm:type>text</ibmwcm:type> <ibmwcm:value>New Product Released</ibmwcm:value> </ibmwcm:element>
HTML element
Element parameters: | Details for this element: |
---|---|
Applies to item types | HTML components, site areas and content items |
Required for item types | HTML components. |
Allowable Values | The value of the value sub-element should be HTML which will be stored in the corresponding HTML element. The HTML can either be entity-encoded or contained within a CDATA element. Alternatively, the feed producer can provide a URL to an HTML file whose contents will be retrieved by the Web Content Integrator |
Required Attributes |
|
Optional Attributes | None |
Required sub-elements |
|
Optional sub-elements | None |
Examples:
<ibmwcm:element name="footer"> <ibmwcm:type>html</ibmwcm:type> <ibmwcm:value> <strong>Copyright 2006</strong> </ibmwcm:value> </ibmwcm:element> <ibmwcm:element name="footer"> <ibmwcm:type>html</ibmwcm:type> <ibmwcm:value> <![CDATA[<strong>Copyright 2006</strong>]]> </ibmwcm:value> </ibmwcm:element> <ibmwcm:element name="footer"> <ibmwcm:type>html</ibmwcm:type> <ibmwcm:source> http://sourcecms.yourco.com/pages/footer.htm </ibmwcm:source> </ibmwcm:element>
Rich text element
Element parameters: | Details for this element: |
---|---|
Applies to item types | Site areas and content items |
Required for item types | None |
Allowable Values | The value of the value sub-element should be HTML which will be stored in the corresponding rich text element. The HTML can either be entity-encoded or contained within a CDATA element. |
Required Attributes |
|
Optional Attributes | None |
Required sub-elements |
|
Optional sub-elements | None |
Examples:
<ibmwcm:element name="body"> <ibmwcm:type>rich text</ibmwcm:type> <ibmwcm:value> <p>This is the content<p/p> </ibmwcm:value> </ibmwcm:element> <ibmwcm:element name="body"> <ibmwcm:type>rich text</ibmwcm:type> <ibmwcm:value> <![CDATA[<p>This is the content</p>]]> </ibmwcm:value> </ibmwcm:element>
File resource element
Element parameters: | Details for this element: |
---|---|
Applies to item types | File resource components, site areas and content items |
Required for item types | File resource components. |
Allowable Values | The value should be a fully qualified URL that points to the binary file which is to be uploaded into file resource element. |
Required Attributes |
|
Optional Attributes | None |
Required sub-elements |
|
Optional sub-elements |
|
Examples:
<ibmwcm:element name="attachment"> <ibmwcm:type>file</ibmwcm:type> <ibmwcm:source> http://sourcecms.yourco.com/files/plan.doc </ibmwcm:source> </ibmwcm:element> <ibmwcm:element name="attachment"> <ibmwcm:type>file</ibmwcm:type> <ibmwcm:source> http://sourcecms.yourco.com/files/plan.doc </ibmwcm:source> <ibmwcm:fileName>MktgPlan.doc</ibmwcm:fileName> </ibmwcm:element>
Image element
Element parameters: | Details for this element: |
---|---|
Applies to item types | Image components, site areas and content items |
Required for item types | Image components. |
Allowable Values | The value should be a fully qualified URL that points to the binary file which is to be uploaded into image element. |
Required Attributes |
|
Optional Attributes | None |
Required sub-elements |
|
Optional sub-elements |
|
Examples:
<ibmwcm:element name="image"> <ibmwcm:type>image</ibmwcm:type> <ibmwcm:source> http://sourcecms.yourco.com/images/logo.gif </ibmwcm:source> </ibmwcm:element> <ibmwcm:element name="image"> <ibmwcm:type>image</ibmwcm:type> <ibmwcm:source> http://sourcecms.yourco.com/images/logo.gif </ibmwcm:source> <ibmwcm:fileName>yourco_logo.doc</ibmwcm:fileName> </ibmwcm:element>
Date element
Element parameters: | Details for this element: |
---|---|
Applies to item types | Date and time components, site areas and content items |
Required for item types | Date and time components. |
Allowable Values | A date or time value to be stored in a date and time element. |
Required Attributes |
|
Optional Attributes | None |
Required sub-elements |
|
Optional sub-elements |
|
Example:
<ibmwcm:element name="StartDate"> <ibmwcm:type>date</ibmwcm:type> <ibmwcm:value> Thu, 14 Apr 1966 15:15:00 EDT </ibmwcm:value> <ibmwcm:format>date</ibmwcm:format> </ibmwcm:element>
Link element
Element parameters: | Details for this element: |
---|---|
Applies to item types | Link components, site areas and content items |
Required for item types | Link components. |
Allowable Values | This component contains the information that is required to configure a link element. There are a number of optional sub-elements that can be used to set the various parameters of the Link field. |
Required Attributes |
|
Optional Attributes | None |
Required sub-elements |
|
Optional sub-elements |
|
- Simple Link to external URL for IBM.com
<ibmwcm:element name="Link"> <ibmwcm:type>link</ibmwcm:type> <ibmwcm:value>http://www.ibm.com</ibmwcm:value> <ibmwcm:format>ExternalLink</ibmwcm:format> <ibmwcm:linkText type="text">IBM</ibmwcm:linkText> </ibmwcm:element>
- Expanded link to external URL for IBM.com
<ibmwcm:element name="Link"> <ibmwcm:type>link</ibmwcm:type> <ibmwcm:value>http://www.ibm.com/search</ibmwcm:value> <ibmwcm:format>ExternalLink</ibmwcm:format> <ibmwcm:linkText type="text">RSS Feed Format Resources</ibmwcm:linkText> <ibmwcm:linkDescription>Search for RSS Feed Format</ibmwcm:linkDescription> <ibmwcm:queryString><![CDATA[?q=rss+feed+format]]></ibmwcm:queryString> <ibmwcm:linkTarget>_blank</ibmwcm:linkTarget> <ibmwcm:additionalAttributes>class="extLink"</ibmwcm:additionalAttributes> </ibmwcm:element>
- Simple link to a file resource component
<ibmwcm:element name="Link"> <ibmwcm:type>link</ibmwcm:type> <ibmwcm:value>63000001</ibmwcm:value> <ibmwcm:format>ManagedContent</ibmwcm:format> <ibmwcm:linkText type="imageGuid">290df293e20a</ibmwcm:linkText> <ibmwcm:allowClear>true</ibmwcm:allowClear> </ibmwcm:element>
- Simple Link to another content item
<ibmwcm:element name="Link"> <ibmwcm:type>link</ibmwcm:type> <ibmwcm:value>80220102</ibmwcm:value> <ibmwcm:format>ManagedContent</ibmwcm:format> <ibmwcm:linkText type="html"><![CDATA[<b>Marketing Plan</b>]]></ibmwcm:linkText> </ibmwcm:element>
Number element
Element parameters: | Details for this element: |
---|---|
Applies to item types | Number components, site areas and content items |
Required for item types | Number components. |
Allowable Values | A numeric value to be stored in a number element. |
Required Attributes |
|
Optional Attributes | None |
Required sub-elements |
|
Optional sub-elements |
|
Example:
<ibmwcm:element name="FileSize"> <ibmwcm:type>number</ibmwcm:type> <ibmwcm:value>34082</ibmwcm:value> <ibmwcm:format>integer</ibmwcm:format> </ibmwcm:element>
Option selection element
Element parameters: | Details for this element: |
---|---|
Applies to item types | Site areas and content items |
Required for item types | None |
Allowable Values | This component contains a list of values that will be set as the selected options in an option selection element. |
Required Attributes |
|
Optional Attributes | None |
Required sub-elements |
|
Optional sub-elements |
|
- Example 1:
- Selecting a single category where the category is in the same
library as the item. In this example "Days" is the name of a taxonomy
and "Monday" is the name of a category.
<ibmwcm:element name="DayOfTheWeek"> <ibmwcm:type>option</ibmwcm:type > <ibmwcm:optionType>taxonomy</ibmwcm:optionType> <ibmwcm:selectedCategory>Days/Monday</ibmwcm:selectedCategory> < /ibmwcm:element>
- Example 2:
- Selecting multiple categories where the categories are in the
same library as the item.
<ibmwcm:element name="DayOfTheWeek"> <ibmwcm:type>option</ibmwcm:type > <ibmwcm:optionType>taxonomy</ibmwcm:optionType> <ibmwcm:selectedCategory>Days/Monday</ibmwcm:selectedCategory> <ibmwcm:selectedCategory>Days/Tuesday</ibmwcm:selectedCategory> < ;/ibmwcm:element>
- Example 3:
- Selecting a single category where the category is in a different
library to the item.
<ibmwcm:element name="DayOfTheWeek"> <ibmwcm:type>option</ibmwcm:type > <ibmwcm:optionType>taxonomy</ibmwcm:optionType> <ibmwcm:selectedCategory library="shared">Days/Monday</ibmwcm:selectedCategory> </ibmwcm:element>
- Example 4:
- Selecting a user defined option. In this example "False" is an
option defined by a user on the Authoring Template for an item.
<ibmwcm:element name="Enable"> <ibmwcm:type>option</ibmwcm:type > <ibmwcm:optionType>user</ibmwcm:optionType> <ibmwcm:selectedOption>False</ibmwcm:selectedOption> </ibmwcm:element>
Component reference element
Element parameters: | Details for this element: |
---|---|
Applies to item types | Site areas and content items |
Required for item types | None |
Allowable Values | This component contains the GUID of a component. |
Required Attributes |
|
Optional Attributes | None |
Required sub-elements |
|
Optional sub-elements | None |
Example:
<ibmwcm:element name="Footer"> <ibmwcm:type>reference</ibmwcm:type> <ibmwcm:value>29bc2daf3289</ibmwcm:value> </ibmwcm:element>
User selection element
Element parameters: | Details for this element: |
---|---|
Applies to item types | User selection components, site areas and content items |
Required for item types | User selection components. |
Allowable Values | A list of names of users to be selected in a user selection element. |
Required Attributes |
|
Optional Attributes | None |
Required sub-elements |
|
Optional sub-elements | None |
Example:
<ibmwcm:element name="Users"> <ibmwcm:type>userSelect</ibmwcm:type> <ibmwcm:value>wpsadmin,John Smith</ibmwcm:value> </ibmwcm:element>
Style sheet element
Element parameters: | Details for this element: |
---|---|
Applies to item types | Style sheet components |
Required for item types | Style sheet components |
Allowable Values | A URL that points to a CSS file which will be uploaded into a style sheet component. |
Required Attributes | None |
Optional Attributes | None |
Required sub-elements |
|
Optional sub-elements |
|
Example:
<ibmwcm:element name="cssFile"> <ibmwcm:type>styleSheet</ibmwcm:type> <ibmwcm:source>http://www.yourco.com/styles/news.css</ibmwcm:source> <ibmwcm:format>alternate</ibmwcm:format> <ibmwcm:mediaType>print</ibmwcm:mediaType> </ibmwcm:element>