| Oracle® WebCenter Framework Developer's Guide 10g (10.1.3.2.0) B31074-04 |
|
![]() Previous |
![]() Next |
The chapter describes node type definitions for Oracle WebCenter adapters for Microsoft SharePoint and EMC Documentum. It contains the following sections:
Section F.1, "Node Type Definitions for the Oracle WebCenter Adapter for Microsoft SharePoint"
Section F.2, "Node Type Definitions for the Oracle WebCenter Adapter for EMC Documentum"
The following description of Microsoft SharePoint Services is provided to support the explanation of the node types of Oracle WebCenter adapter for Microsoft SharePoint. Refer to your Microsoft SharePoint Services documentation for a full description of SharePoint Services.
Figure F-1 illustrates the structure of SharePoint Services.
The SQL Server 2000 databases (1) are a collection of content databases that are used to store SharePoint repository data.
The Web Servers (2), represent the collection of front-end Web servers that in turn contain one or more Virtual Servers (3).
Each Virtual Server has one or more Site Collections (4).
Each Site Collection includes any number of Site objects.
Within a Site collection there is a Top-level Web Site (5).
The Top-level Web Site corresponds to the root of the JCR hierarchy of the Oracle WebCenter adapter for Microsoft SharePoint.
A Site object can contain a collection of Subsites and a collection of Lists.
Each List object (6) contains Fields (7) and List Items (8).
The Fields provide information about the List Items. Each List Item represents a single object contained within the List.
SharePoint provides several predefined list types, for example, Document Library, Links List, Contacts List, and it also allows for creation of custom list types.
The following sections describe how these SharePoint structures are represented by the Oracle WebCenter adapter for Microsoft SharePoint:
The Oracle WebCenter adapter for Microsoft SharePoint defines a single namespace for all node types used by SharePoint. In this documentation this namespace is denoted by the prefix sp.
The sp:Object type is for all SharePoint objects. All node types of the Oracle WebCenter adapter for Microsoft SharePoint are extended from it. This object has the signature shown in Table F-1.
The sp:Object type does not define any child nodes or properties.
The sp:Collection type represents a collection, and is the base type of all collections. It has the signature shown in Table F-2.
The sp:Collection type does not define child nodes or any properties.
The sp:WebCollection type represents collection of SharePoint web sites. The sp:WebCollection type has the signature shown in Table F-3.
Table F-3 Web Collection Signature
| Type | Value |
|---|---|
|
Namespace |
sp |
|
Local name |
WebCollection |
|
Super types |
sp:Collection |
The sp:WebCollection type defines the child node types shown in Table F-4.
Table F-4 Child Node Types of Web Collection
| Name | Declared Node Type | Auto-created | Mandatory | Allows Same Name Siblings | Protected | Default Primary Node Type | Required Primary Types |
|---|---|---|---|---|---|---|---|
|
* |
sp:Web Collection |
No |
No |
No |
No |
sp:Web |
sp:Web |
The sp:WebCollection type does not define any properties.
The sp:ListCollection type represents a collection of SharePoint lists. The sp:ListCollection type has the signature shown in Table F-5.
Table F-5 List Collection Signature
| Type | Value |
|---|---|
|
Namespace |
sp |
|
Local name |
ListCollection |
|
Super types |
sp:Collection |
The sp:ListCollection type defines the child node types shown in Table F-6.
Table F-6 Child Node Types of List Collection
| Name | Declared Node Type | Auto-created | Mandatory | Allows Same Name Siblings | Protected | Default Primary Node Type | Required Primary Types |
|---|---|---|---|---|---|---|---|
|
* |
sp:List Collection |
No |
No |
No |
No |
sp:List |
sp:List |
The sp:ListCollection type does not define any properties.
The sp:FieldCollection type represents field collection of SharePoint list. The sp:FieldCollection type has the signature shown in Table F-7.
Table F-7 Field Collection Signature
| Type | Value |
|---|---|
|
Namespace |
sp |
|
Local name |
FieldCollection |
|
Super types |
sp:Collection |
The sp:FieldCollection type defines child node types shown in Table F-8.
Table F-8 Child Node Types of Field Collection
| Name | Declared Node Type | Auto-created | Mandatory | Allows Same Name Siblings | Protected | Default Primary Node Type | Required Primary Types |
|---|---|---|---|---|---|---|---|
|
* |
sp:Field Collection |
No |
No |
No |
No |
sp:Field |
sp:Field |
|
* |
sp:FieldCollection |
No |
No |
No |
No |
sp:Calculated Field |
sp:Calculated Field |
|
* |
sp:FieldCollection |
No |
No |
No |
No |
sp:Choice Field |
sp:Choice Field |
|
* |
sp:FieldCollection |
No |
No |
No |
No |
sp:Currency Field |
sp:Currency Field |
|
* |
sp:FieldCollection |
No |
No |
No |
No |
sp:DateTime Field |
sp:DateTime Field |
|
* |
sp:FieldCollection |
No |
No |
No |
No |
sp:MultiChoice Field |
sp:MultiChoice Field |
|
* |
sp:FieldCollection |
No |
No |
No |
No |
sp:MultiLine TextField |
sp:MultiLine TextField |
|
* |
sp:FieldCollection |
No |
No |
No |
No |
sp:Number Field |
sp:Number Field |
|
* |
sp:FieldCollection |
No |
No |
No |
No |
sp:LookupField |
sp:LookupField |
|
* |
sp:FieldCollection |
No |
No |
No |
No |
sp:RatingScale Field |
sp:RatingScale Field |
|
* |
sp:FieldCollection |
No |
No |
No |
No |
sp:TextField |
sp:TextField |
|
* |
sp:FieldCollection |
No |
No |
No |
No |
sp:URLField |
sp:URLField |
|
* |
sp:FieldCollection |
No |
No |
No |
No |
sp:UserField |
sp:UserField |
|
* |
sp:FieldCollection |
No |
No |
No |
No |
sp:Computed Field |
sp:Computed Field |
The sp:FieldCollection type does not define any properties.
The sp:SiteTemplateCollection type represents collection of site's templates. The sp:SiteTemplateCollection type has the signature shown in Table F-9.
Table F-9 Site Template Collection Signature
| Type | Value |
|---|---|
|
Namespace |
sp |
|
Local name |
SiteTemplateCollection |
|
Super types |
sp:Collection |
The sp:SiteTemplateCollection type defines child node types shown in Table F-10.
Table F-10 Child Node Types of Site Template Collection
| Name | Declared Node Type | Auto-created | Mandatory | Allows Same Name Siblings | Protected | Default Primary Node Type | Required Primary Types |
|---|---|---|---|---|---|---|---|
|
* |
sp:Template Collection |
No |
No |
No |
No |
sp: SiteTemplate |
sp: SiteTemplate |
The sp:SiteTemplateCollection type does not define any properties.
The sp:ItemCollection node type represents collection of files and folders in the SharePoint document library. The sp:ItemCollection type has the signature shown in Table F-11.
Table F-11 Item Collection Signature
| Type | Value |
|---|---|
|
Namespace |
sp |
|
Local name |
ItemCollection |
|
Super types |
sp:Collection |
The sp:ItemCollection type defines child node types shown in Table F-12.
Table F-12 Child Node Types of Item Collection
| Name | Declared Node Type | Auto-created | Mandatory | Allows Same Name Siblings | Protected | Default Primary Node Type | Required Primary Types |
|---|---|---|---|---|---|---|---|
|
* |
sp:ItemCollection |
No |
No |
No |
No |
sp:ListItem |
sp:ListItem |
The sp:ItemCollection type does not define any properties.
The sp:FileCollection type represents collection of files and folders in the SharePoint document library. The sp:FileCollection type has the signature shown in Table F-13.
Table F-13 File Collection Signature
| Type | Value |
|---|---|
|
Namespace |
sp |
|
Local name |
FileCollection |
|
Super types |
sp:Collection |
The sp:FileCollection type defines child node types shown in Table F-14.
Table F-14 Child Node Types of File Collection
| Name | Declared Node Type | Auto-created | Mandatory | Allows Same Name Siblings | Protected | Default Primary Node Type | Required Primary Types |
|---|---|---|---|---|---|---|---|
|
* |
sp:FileCollection |
No |
No |
No |
No |
sp:ListItem |
sp:ListItem |
|
* |
sp:FileCollection |
No |
No |
No |
No |
sp:Folder |
sp:Folder |
The sp:FileCollection type does not define any properties.
The sp:Site type represents site and is the root node of JCR. The sp:Site type has the signature shown in Table F-15.
The sp:Site type defines child node types shown in Table F-16.
Table F-16 Child Nodes Types of Site
| Name | Declared Node Type | Auto-created | Mandatory | Allows Same Name Siblings | Protected | Default Primary Node Type | Required Primary Types |
|---|---|---|---|---|---|---|---|
|
sp:RootWeb |
sp:Site |
Yes |
Yes |
No |
Yes |
sp:WebSite |
sp:WebSite |
|
sp:Templates |
sp:Site |
Yes |
Yes |
No |
Yes |
sp:Template Collection |
sp:Template Collection |
The sp:Site type defines the properties shown in Table F-17.
Table F-17 Site Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
allowUnsafeUpdates |
Boolean |
Yes |
False |
No |
No |
Yes |
Contains a flag that specifies whether to allow updates to the database as a result of a GET request or without requiring a security validation. |
|
allWebs |
Reference |
No |
- |
No |
Yes |
Yes |
Contains references on all Web sites available within the site collection, including the top-level site and nested subsites. |
|
catchAccessDenied Exception |
Boolean |
Yes |
False |
No |
No |
Yes |
Contains a flag that specifies whether to handle access denied exceptions and require user authentication. |
|
certificationDate |
Date |
No |
- |
No |
No |
Yes |
Contains date on which usage was checked for the site collection. |
|
deadWeb NotificationCount |
Long |
No |
- |
No |
No |
Yes |
Contains the number of Web site notifications within the site collection that are out of use. |
|
globalPermMask |
String |
No |
- |
No |
No |
Yes |
Contains the rights for the permissions mask that is used globally on the virtual server. |
|
hostName |
String |
No |
- |
No |
No |
Yes |
Contains the name of the server that hosts the site collection. |
|
iisAllowsAnonymous |
Boolean |
Yes |
False |
No |
No |
Yes |
Contains a flag that indicates whether anonymous access is enabled in Internet Information Services (IIS). |
|
lastContent ModifiedDate |
Date |
No |
- |
No |
No |
Yes |
Contains the date and time in Coordinated Universal Time (UTC) when the content of the site was last changed. |
|
lastSecurity ModifiedDate |
Date |
No |
- |
No |
No |
Yes |
Contains the date and time in Coordinated Universal Time (UTC) when security on the site was last changed. |
|
lockIssue |
String |
No |
- |
No |
No |
Yes |
Contains the explanation for locking a site collection. |
|
owner |
String |
No |
- |
No |
No |
Yes |
Contains the owner of the site collection. |
|
port |
Long |
No |
- |
No |
No |
Yes |
Contains the port number used for input and output on the virtual server containing the site collection. |
|
portalName |
String |
No |
- |
No |
No |
Yes |
Contains the name of a portal. |
|
portalUrl |
String |
No |
- |
No |
No |
Yes |
Contains the URL to a portal. |
|
protocol |
String |
No |
- |
No |
No |
Yes |
Contains the protocol, HTTP or HTTPS that is used by the server. |
|
quota |
String |
No |
- |
No |
No |
Yes |
Contains a quota for the site collection. |
|
readLocked |
Boolean |
Yes |
False |
No |
No |
Yes |
Contains a flag that indicates whether the site collection is locked and unavailable for Read access. |
|
secondaryContact |
String |
No |
- |
No |
No |
Yes |
Contains the secondary contact used for the site collection. |
|
serverReletiveUrl |
String |
No |
- |
No |
No |
Yes |
Contains the server-relative URL of the top-level Web site in the site collection. |
|
url |
String |
No |
- |
Yes |
No |
Yes |
Contains the URL of the top-level Web site in the site collection, including host name, port number, and path. |
|
usageInfo |
String |
No |
- |
No |
No |
Yes |
Contains information about site usage, including bandwidth, storage, and number of visits to the site collection. |
|
warning NotificationSent |
Boolean |
Yes |
False |
No |
No |
Yes |
Contains a flag that indicates whether a warning notification was sent. |
|
writeLocked |
Boolean |
Yes |
False |
No |
No |
Yes |
Contains a flag that indicates whether the site collection is locked and unavailabe for Write access. |
This section describes the following node types:
The sp:ListTemplate type represents templates of lists and contains the signature shown in Table F-18.
Table F-18 List Template Signature
| Type | Value |
|---|---|
|
Namespace |
sp |
|
Local name |
ListTemplate |
|
Super types |
sp:Object |
The sp:ListTemplate type does not define any child node types. The sp:ListTemplate type defines the properties shown in Table F-19.
Table F-19 List Template Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
baseType |
String |
No |
- |
Yes |
No |
Yes |
Contains the base type for the list definition or list template. |
|
catalog |
Boolean |
Yes |
- |
Yes |
No |
Yes |
Specifies whether the list definition is for a site gallery, a list gallery, or a Web Part gallery. |
|
description |
String |
No |
- |
Yes |
No |
Yes |
Contains the description of the list definition or list template that is displayed in the user interface. |
|
displayName |
String |
No |
- |
Yes |
No |
Yes |
Contains the display name for the list definition or list template. |
|
dontSaveInTemplate |
Boolean |
Yes |
- |
Yes |
No |
Yes |
Contains a flag that specifies whether to exclude the content of the list when the list is saved as a custom list template or when the site to which the list belongs is saved as a custom site template through the user interface. |
|
documentTemplate |
String |
Yes |
- |
Yes |
No |
Yes |
Corresponds the type of the default creating document. |
|
hidden |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that specifies whether the list definition or list template is hidden from Web site users and does not appear as an option on the Documents and Lists page. |
|
hiddenList |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that specifies whether a list created from the list definition is hidden. |
|
image |
String |
No |
- |
Yes |
No |
Yes |
Contains the relative path, based on the server, for the image used to represent the list definition or list template. |
|
isCustomTemplate |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that indicates whether the |
|
name |
String |
No |
- |
Yes |
No |
Yes |
Contains the display name for the list definition or list template. |
|
onQuickLanch |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that specifies whether any list created with the list definition or list template is displayed on the Quick Launch bar. |
|
rootWebOnly |
Boolean |
Yes |
- |
Yes |
No |
Yes |
Specifies whether the list created from the definition exists only in the root Web site of a site collection. |
|
securityBits |
String |
Yes |
- |
Yes |
No |
Yes |
Defines read, write, and schema design security. Each digit in the string corresponds to the three security settings contained in the List of Lists database table. This attribute does not apply to document libraries. |
|
type |
String |
No |
- |
Yes |
No |
Yes |
Contains the type of the list definition or list template. |
|
unique |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that indicates whether the list definition or list template is used to create only one list in the site collection. |
The sp:SiteTemplate type represents templates of the site and contains the signature shown in Table F-20.
Table F-20 Site Template Signature
| Type | Value |
|---|---|
|
Namespace |
sp |
|
Local name |
SiteTemplate |
|
Super types |
sp:Object |
The sp:SiteTemplate type does not define any child node types. The sp:SiteTemplate type defines the properties shown in Table F-21.
Table F-21 Site Template Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
id |
String |
Yes |
- |
Yes |
No |
Yes |
Contains the unique template identifier. |
|
description |
String |
No |
- |
Yes |
No |
Yes |
Contains the description for the site definition or site template. |
|
imageUrl |
String |
No |
- |
Yes |
No |
Yes |
Contains the URL for the image that is used to represent the site definition or site template in the user interface. |
|
isCustomTemplate |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that indicates whether the |
|
isHidden |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that indicates whether the site definition or site template is displayed as an option for creating a site collection on the Template Selection page. |
|
isUnique |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that indicates whether the site created from the site definition or site template inherits from its parent Web site. |
|
name |
String |
No |
- |
Yes |
No |
Yes |
Contains the name of the site definition or site template. |
|
title |
String |
No |
- |
Yes |
No |
Yes |
Contains the display name for the site definition or site template. |
The sp:Item node is a base JCR type of a List and Web SharePoint object. It extends List and Web node types of SharePoint. The sp:Item type has the signature shown in Table F-22.
The sp:Item type does not define child node types. It contains the properties shown in Table F-23.
Table F-23 Item Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
title |
String |
No |
- |
Yes |
No |
Yes |
Contains title of item. |
|
description |
String |
No |
- |
No |
No |
Yes |
Contains description of item. |
|
author |
String |
Yes |
Current user |
Yes |
No |
Yes |
Contains name of user, who created item. |
|
lastModified |
Date |
Yes |
Current date |
Yes |
No |
Yes |
Contains the date when the item was last modified. |
|
lastModifiedForceRecrawl |
Date |
Yes |
Current date |
Yes |
No |
Yes |
Contains date of last modification, which was forced by recrawl. |
|
validSecurityInfo |
Boolean |
No |
True |
Yes |
No |
Yes |
Contains a flag that shows that security information is valid. |
|
inheritedSecurity |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a flag that shows that security is equals to parent item. |
|
allowAnonymousAccess |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a flag that shows that anonymous user has access to item. |
|
anonymousViewListItems |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a flag that shows that anonymous user can view list items. |
|
permission |
String |
No |
- |
No |
No |
Yes |
Contains permissions as string. |
The sp:Web is a JCR type. It provides information about the Web SharePoint object. The sp:Web type has the signature shown in Table F-24.
The sp:Web type defines the child node types shown in Table F-25.
Table F-25 Child Node Types of Web
| Name | Declared Node Type | Auto-created | Mandatory | Allows Same Name Siblings | Protected | Default Primary Node Type | Required Primary Types |
|---|---|---|---|---|---|---|---|
|
sp:List |
sp:Web |
Yes |
Yes |
No |
Yes |
sp:List Collection |
sp:List Collection |
The sp:Web type defines the properties shown in Table F-26.
Table F-26 Web Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
url |
String |
No |
- |
Yes |
No |
Yes |
Contains URL of site. |
|
webId |
String |
Yes |
Generated |
Yes |
No |
Yes |
Contains SharePoint internal Id of site. |
|
language |
Long |
No |
- |
Yes |
No |
Yes |
Contains language of site. |
|
noIndex |
String |
No |
- |
No |
No |
Yes |
Contains no index text. |
|
externalSecurity |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that shows that the site supports external security. |
|
categoryId |
String |
No |
- |
No |
No |
Yes |
Contains Id of site's category. |
|
categoryName |
String |
No |
- |
No |
No |
Yes |
Contains name of site's category. |
|
categoryIdPath |
String |
No |
- |
No |
No |
Yes |
Contains path of id category of site. |
|
isBucketWeb |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that shows that site is bucket web. |
|
usedInAutocat |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that shows that site is used in autocat. |
|
categoryBucketId |
Boolean |
No |
- |
No |
No |
Yes |
Contains Id of category's bucket. |
The sp:Web type provides the default values for properties of extended node types, as shown in Table F-27.
The sp:WebSite type provides information about a Web SharePoint object. The sp:WebSite type has the signature shown in Table F-28.
The sp:WebSite type defines the child node types shown in Table F-29.
Table F-29 Child Nodes Types of Web Site
| Name | Declared Node Type | Auto-created | Mandatory | Allows Same Name Siblings | Protected | Default Primary Node Type | Required Primary Types |
|---|---|---|---|---|---|---|---|
|
sp:Webs |
sp:Web |
yes |
yes |
no |
yes |
sp:Web Collection |
sp:Web Collection |
The sp:WebSite type does not define any properties.
The sp:List type provides information about a SharePoint list object. The sp:List type has the signature shown in Table F-30.
Table F-30 List Signature
| Type | Value |
|---|---|
|
Namespace |
sp |
|
Local name |
List |
|
Super types |
sp:Item nt:hierarchyNode |
The sp:List type defines the child node types shown in Table F-31.
Table F-31 Child Node Types of List
| Name | Declared Node Type | Auto-created | Mandatory | Allows Same Name Siblings | Protected | Default Primary Node Type | Required Primary Types |
|---|---|---|---|---|---|---|---|
|
sp:Items |
sp:List |
Yes |
Yes |
No |
Yes |
sp:Item Collection |
sp:Item Collection |
|
sp:RegionalSettings |
sp:List |
Yes |
Yes |
No |
Yes |
sp:Regional Settings |
sp:Regional Settings |
|
sp:Fields |
sp:List |
Yes |
Yes |
No |
Yes |
sp:Field Collection |
sp:Field Collection |
|
sp:Forms |
sp:List |
Yes |
Yes |
No |
Yes |
sp:Form Collection |
sp:Form Collection |
|
sp:Views |
sp:List |
Yes |
Yes |
No |
Yes |
sp:View Collection |
sp:View Collection |
The sp:List type defines the properties shown in Table F-32.
Table F-32 List Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
allowDeletion |
Boolean |
Yes |
True |
Yes |
No |
Yes |
Contains a flag that shows do allow deletion items from list. |
|
allowMultiResponses |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that shows do allow multi responses. |
|
anonymousPermMask |
Long |
No |
- |
Yes |
No |
Yes |
Contains type of anonymous perm mask. |
|
author |
Long |
No |
- |
Yes |
No |
Yes |
Contains Id of the user who created the list. |
|
baseTemplate |
String |
No |
- |
Yes |
No |
Yes |
Contains base template of list. |
|
baseType |
String |
No |
- |
Yes |
No |
Yes |
Contains a list of the base type. |
|
created |
Date |
No |
- |
Yes |
No |
Yes |
Contains the date when the list was created. |
|
defaultView |
Reference |
No |
- |
Yes |
No |
Yes |
Contains the reference on default view for the list. |
|
defaultViewUrl |
String |
No |
- |
No |
No |
Yes |
Contains default URL to view the list. |
|
description |
String |
No |
- |
No |
No |
Yes |
Contains description of the list. |
|
direction |
String |
No |
- |
Yes |
No |
Yes |
Contains direction of the list. |
|
enableAttachments |
Boolean |
Yes |
True |
Yes |
No |
Yes |
Contains a flag that shows that attachment is enabled. |
|
enableModeration |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that shows that moderation is enabled. |
|
enableVersioning |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that shows that versioning is enabled. |
|
eventSinkAssembly |
String |
No |
- |
No |
No |
Yes |
Contains strong name of file in the Global Assembly Cache. |
|
eventSinkClass |
String |
No |
- |
No |
No |
Yes |
Contains class name of the event handler. |
|
eventSinkData |
String |
No |
- |
No |
No |
Yes |
Contains arbitrary string that the event handler uses. |
|
excludeFromTemplate |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that indicates whether the content of the list is included when the site to which the list belongs is saved as a custom site template. |
|
hidden |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that shows that the list is hidden. |
|
imageUrl |
String |
No |
- |
Yes |
No |
Yes |
Contains URL of the image. |
|
itemCount |
Long |
No |
- |
Yes |
No |
Yes |
Contains count of list items. |
|
lastItemDeletedDate |
Date |
No |
- |
Yes |
No |
Yes |
Contains date of the last deleted item. |
|
lastItemModifiedDate |
Date |
No |
- |
Yes |
No |
Yes |
Contains date and time that an item, field, or property of the list was last modified. |
|
multipleDataList |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that shows that list supports multiple data. |
|
onQuickLaunch |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that specifies whether the list appears on the Quick Launch area of the home page. |
|
ordered |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that shows that the list is ordered. |
|
permissions |
String |
No |
- |
No |
No |
Yes |
Contains the collection of permission objects, which represents all the permissions for the list. |
|
propertiesXml |
String |
No |
- |
No |
No |
Yes |
Contains a fragment in Collaborative Application Markup Language (CAML) that specifies property values for the list. |
|
readSecurity |
Long |
No |
- |
No |
No |
Yes |
Contains type of read security. |
|
rootFolder |
String |
Yes |
Parent/title |
Yes |
No |
Yes |
Contains folder of list. |
|
schemaXml |
String |
No |
- |
No |
No |
Yes |
|
|
showUser |
Boolean |
Yes |
True |
Yes |
No |
Yes |
Contains a flag that indicates that users should be shown. |
|
title |
String |
No |
- |
Yes |
No |
Yes |
Contains the displayed title for the list. |
|
version |
Long |
Yes |
0 |
Yes |
No |
Yes |
Contains the version number of the list. |
|
writeSecurity |
Long |
Yes |
1 |
Yes |
No |
Yes |
Contains write security type of list. |
The sp:List type provides the default values for properties of extended node types, as shown in Table F-33.
The sp:Field type provides information about field of SharePoint list object. This is the base type of all fields. The sp:Field type has the signature shown in Table F-34.
The sp:Field type does not define child node types. It contains the properties shown in Table F-35.
Table F-35 Field Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
colName |
String |
Yes |
- |
Yes |
No |
Yes |
Contains name of the column. |
|
readOnly |
Boolean |
Yes |
True |
Yes |
No |
Yes |
Contains a read-only flag. |
|
hidden |
Boolean |
Yes |
- |
Yes |
No |
Yes |
Contains a hidden flag. |
|
type |
String |
Yes |
- |
Yes |
No |
Yes |
Contains type of the field. |
|
name |
String |
Yes |
- |
Yes |
No |
Yes |
Contains name of the field. |
|
displayName |
String |
Yes |
- |
Yes |
No |
Yes |
Contains display name of the field. |
|
fromBaseType |
Boolean |
Yes |
- |
Yes |
No |
Yes |
Contains a flag that shows origin of the field. |
|
required |
Boolean |
Yes |
True |
Yes |
No |
Yes |
Contains a flag that determines whether the field requires values. |
|
canToggleHidden |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that indicates whether the column can be hidden through the user interface. |
|
defaultFormula |
String |
No |
- |
No |
No |
Yes |
Contains default formula for calculation fields. |
|
defaulValue |
String |
No |
- |
No |
No |
Yes |
Contains default value of the field. |
|
authoringInfo |
String |
No |
- |
No |
No |
Yes |
Contains authoring information of the field. |
|
description |
String |
No |
- |
No |
No |
Yes |
Contains description of the field. |
|
direction |
String |
No |
- |
No |
No |
Yes |
Contains direction of the field. |
|
displaySize |
String |
No |
- |
No |
No |
Yes |
Contains display size of the field. |
|
filterable |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a filterable flag. |
|
filterableBySchema |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a filterable by schema flag. |
|
filterableNoRecurence |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a filterable no recurrence flag. |
|
filterableNoRecurence BySchem |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a filterable no recurrence by schema flag. |
|
imeMode |
String |
No |
- |
No |
No |
Yes |
Contains Input Method Editor (IME) mode. |
|
reorderable |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a flag that indicates whether values in the field can be reordered. |
|
sealed |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a flag that indicates whether other fields can be derived from the field. |
|
sortable |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that determines whether the field can be sorted. |
|
sortableBySchema |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a sortable by schema flag. |
The SharePoint repository supports the types of fields shown in Table F-36.
Table F-36 Field Types
| Type | Description | JSR Type |
|---|---|---|
|
Attachments |
Contains attachments |
|
|
Boolean |
Contains Boolean values that are stored in the database as 1 or 0. |
|
|
Calculated |
Contains calculated values. |
sp:CalculatedField |
|
Choice |
Specifies a predetermined set of values that can be used to enter data into the field. |
sp:ChoiceField |
|
Computed |
Specifies an abstract field type that depends on other fields for its content and definition. |
sp:ComputedField |
|
Counter |
Contains an integer used for internal Id fields. |
sp:NubmerField |
|
CrossProjectLink |
Specifies a link between projects in a Meetings Workspace site. |
sp:UrlField |
|
Currency |
Contains currency values formatted based on a specific locale. |
sp:CurrencyField |
|
DateTime |
Contains date and time values. |
sp:DateTimeField |
|
Error |
Contains errors. |
|
|
File |
Contains files. |
|
|
GridChoice |
Specifies a Choice field for a data sheet. |
sp:ChoiceField |
|
Guid |
Contains GUIDs. |
|
|
Integer |
Contains positive or negative integer values. |
sp:NumberField |
|
Invalid |
Not used. |
|
|
Lookup |
Contains references to values in other lists. |
sp:LookupField |
|
MaxItems |
Contains the maximum number of items. |
|
|
ModStat |
Specifies Content Approval status. |
sp:MultiChoiceField |
|
MultiChoice |
Contains multiple values per list item. |
sp:MultiChoiceField |
|
Note |
Specifies a field that can contain multiple lines of text. |
sp:MultiLineTextField |
|
Number |
Contains floating point numbers. |
sp:NumberField |
|
Recurrence |
Specifies a field used in calendars for recurring events and, like computed fields, an abstract field type that depends on other fields for its content and definition. |
|
|
Text |
Contains a single line of text. |
sp:TextField |
|
Threading |
Specifies a field that is used in the creation and display of threaded Web discussions. |
|
|
URL |
Contains hyperlinks. |
sp:UrlField |
|
User |
Specifies users of a SharePoint site. |
sp:UserField |
The sp:ComputedField type represents a field that depends on other fields in a SharePoint list. The sp:ComputedField type contains signature shown in Table F-37.
Table F-37 Computed Field Signature
| Type | Value |
|---|---|
|
Namespace |
Sp |
|
Local name |
ComputedField |
|
Super types |
sp:Field |
The sp:ComputedField type does not define child node types. It contains the properties shown in Table F-38.
Table F-38 Computed Field Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
FieldRefs |
String |
No |
- |
Yes |
Yes |
Yes |
Contains a collection of field references used to define computed fields. |
|
DisplayPattern |
String |
No |
- |
Yes |
No |
Yes |
Is used to define how the field is rendered. |
The sp:CalculatedField type represents a calculated field in a SharePoint list. The sp:CalculatedField type contains the signature shown in Table F-39.
Table F-39 Calculated Field Signature
| Type | Value |
|---|---|
|
Namespace |
Sp |
|
Local name |
CalculatedField |
|
Super types |
sp:Field |
The sp:CalculatedField type does not define child node types. It defines properties shown in Table F-40.
Table F-40 Calculated Field Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
currency |
String |
No |
- |
No |
No |
Yes |
Contains the currency format that is used in the field. |
|
dateFormat |
String |
No |
- |
No |
No |
Yes |
Contains the date and time formatting that is used in the field. |
|
displayFormat |
String |
No |
- |
No |
No |
Yes |
Contains the number format that is displayed in the field. |
|
formula |
String |
No |
- |
Yes |
No |
Yes |
Contains formula used for calculation in the field. |
|
outputType |
String |
No |
- |
Yes |
No |
Yes |
Contains type of field. |
|
showAsPersantage |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a flag that determines whether values in the field are displayed as percentages. |
The sp:ChoiceField type represents a choice field in a SharePoint list. It contains the signature shown in Table F-41.
Table F-41 Choice Field Signature
| Type | Value |
|---|---|
|
Namespace |
Sp |
|
Local name |
ChoiseField |
|
Super types |
sp:Field |
The sp:ChoiceField type does not define child node types. It contains the properties shown in Table F-42.
Table F-42 Choice Field Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
editFormat |
String |
No |
- |
Yes |
No |
Yes |
Contains format whether to display the choice field as radio buttons or as a dropdown list. |
|
soratable |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains a flag that indicates whether the field can be sorted. |
The sp:NumberField type represents a number field in a SharePoint list. The sp:NumberField type contains the signature shown in Table F-43.
Table F-43 Number Field Signature
| Type | Value |
|---|---|
|
Namespace |
sp |
|
Local name |
NumberField |
|
Super types |
sp:Field |
The sp:NumberField type does not define any child node types. It defines the properties shown in Table F-44.
Table F-44 Number Field Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
displayFormat |
String |
No |
- |
Yes |
No |
Yes |
Contains the number of decimal places to use when displaying a field. |
|
maximumValue |
Double |
No |
- |
Yes |
No |
Yes |
Contains maximum value for the field. |
|
minimumValue |
Double |
No |
- |
Yes |
No |
Yes |
Contains minimum value of field. |
|
showAsPersentage |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a flag that specifies whether the field is rendered as a percentage. |
The sp:CurrencyField type represents a currency field in a SharePoint list. The sp:CurrencyField type contains the signature shown in Table F-45.
Table F-45 Currency Field Signature
| Type | Value |
|---|---|
|
Namespace |
Sp |
|
Local name |
CurrencyField |
|
Super types |
sp:NumberField |
The sp:CurrencyField type does not define any child node types. It defines the properties shown in Table F-46.
The sp:DateTimeField type represents a date and time field in a SharePoint list. It contains the signature shown in Table F-47.
Table F-47 Date Time Field Signature
| Type | Value |
|---|---|
|
Namespace |
Sp |
|
Local name |
DateTimeField |
|
Super types |
sp:Field |
The sp:DateTimeField type does not define child node types. It contains the properties shown in Table F-48.
Table F-48 Date Time Field Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
calendarType |
String |
No |
- |
Yes |
No |
Yes |
Contains the type of calendar that is used to display the field. |
|
displayFormat |
String |
No |
- |
Yes |
No |
Yes |
Contains the type of date and time format that is used in the field. |
The sp:LookupField type represents a lookup field in a SharePoint list. The sp:LookupField type contains the signature shown in Table F-49.
Table F-49 Lookup Field Signature
| Type | Value |
|---|---|
|
Namespace |
Sp |
|
Local name |
LookupField |
|
Super types |
sp:Field |
The sp:LookupField type does not define child node types. It defines the properties shown in Table F-50.
Table F-50 Lookup Field Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
lookupField |
String |
No |
- |
Yes |
No |
Yes |
Contains the field from a non-local list to which this field is a lookup. |
|
lookupList |
String |
No |
- |
Yes |
No |
Yes |
Contains the GUID of the list to use for the lookup. |
The sp:MultiChoiseField type represents a field that can contain multiple values. The sp:MultiChoiseField type contains the signature shown in Table F-51.
Table F-51 Multi Choice Field Signature
| Type | Value |
|---|---|
|
Namespace |
Sp |
|
Local name |
MultiChoiseField |
|
Super types |
sp:Field |
The sp:MultiChoiseField type does not define child node types. It defines properties shown in Table F-52.
Table F-52 Multi Choice Field Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
choices |
String |
No |
- |
Yes |
Yes |
Yes |
Contains the choices used in the multichoice field. |
|
fillInChoise |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a flag that determines whether a text box for typing an alternative value is provided for the multichoice field. |
|
sortable |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a flag that indicates whether the multichoice field can be sorted. |
The sp:MultiListTextField type represents a text field that can contain multiple lines. The sp:MultiListTextField type contains the signature shown in Table F-53.
Table F-53 Multi Line Text Field
| Type | Value |
|---|---|
|
Namespace |
Sp |
|
Local name |
MultiLineTextField |
|
Super types |
sp:Field |
The sp:MultiListTextField type does not define child node types. It defines the properties shown in Table F-54.
Table F-54 Multi Line Text Field Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
allowHyperlink |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a flag that specifies whether hyperlinks can be used in the field. |
|
filterable |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a flag that indicates whether the multiline text field can be filtered. |
|
numberOfLines |
Long |
No |
False |
Yes |
No |
Yes |
Contains the number of lines to display in the field. |
|
richText |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a flag that specifies whether rich text formatting can be used in the field. |
|
sortable |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a flag that indicates whether the multiline text field can be sorted. |
The sp:RatingScaleField type represents a rating scale field used in surveys. The sp:RatingScaleField type contains the signature shown in Table F-55.
Table F-55 Rating Scale Field Signature
| Type | Value |
|---|---|
|
Namespace |
Sp |
|
Local name |
RatingScaleField |
|
Super types |
sp:MultiChoiceField |
The sp:RatingScaleField type does not define child node types. It defines the properties shown in Table F-56.
Table F-56 Rating Scale Field Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
filterable |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a flag that indicates whether the rating-scale field can be filtered. |
|
gridEndNumber |
Long |
No |
- |
Yes |
No |
Yes |
Contains the end number for the rating scale. |
|
gridNAOptionText |
String |
No |
- |
Yes |
No |
Yes |
Contains the text to display for the not applicable (N/A) option. |
|
gridStartNumber |
Long |
No |
- |
Yes |
No |
Yes |
Contains the start number for the rating scale. |
|
gridTextRangeAverage |
String |
No |
- |
Yes |
No |
Yes |
Contains the text to display for average ratings. |
|
gridRangeHigh |
String |
No |
- |
Yes |
No |
Yes |
Contains the text to display for high ratings. |
|
gridRangeLow |
String |
No |
- |
Yes |
No |
Yes |
Contains the text to display for low ratings. |
|
sortable |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a flag that indicates whether the rating-scale field can be sorted. |
The sp:TextField type represents a rating scale field used in surveys. The sp:TextField type contains the signature shown in Table F-57.
The sp:TextField type does not define child node types. It defines properties shown in Table F-58.
The sp:UrlField type represents a rating scale field used in surveys. The sp:UrlField type contains the signature shown in Table F-59.
The sp:UrlField type does not define child node types. It defines the properties shown in Table F-60.
Table F-60 URL Field Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
displayFormat |
String |
No |
- |
Yes |
No |
Yes |
Contains value that determines whether the field is displayed as an image or as a hyperlink. |
|
filterable |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a flag that indicates whether the URL field can be filtered. |
The sp:UserField type represents a user field. The sp:UserField type contains the signature shown in Table F-61.
Table F-61 User Field Signature
| Type | Value |
|---|---|
|
Namespace |
Sp |
|
Local name |
UserField |
|
Super types |
sp:LookupField |
The sp:UserField type does not define child node types. It defines the properties shown in Table F-62.
Table F-62 User Field Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
allowDisplay |
Boolean |
No |
True |
Yes |
No |
Yes |
Contains a flag that specifies whether to display the name of the user who created or last modified the field. |
|
presence |
Boolean |
No |
False |
Yes |
No |
Yes |
Contains a flag that specifies whether presence is enabled on the field to display user names and e-mail addresses. |
The sp:Form type represents a list item to create, display, or edit a form, in a list. It contains the signature shown in Table F-63.
The sp:Form type does not define child node types. It defines the properties shown in Table F-64.
Table F-64 Form Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
schemaXml |
String |
No |
- |
Yes |
No |
Yes |
Contains the schema in CAML that defines the form. |
|
type |
String |
No |
- |
Yes |
No |
Yes |
Contains the type of the form. |
|
url |
String |
No |
- |
Yes |
No |
Yes |
Gets the site-relative URL of the form. |
The sp:View type represents a view of the data contained in a list on a SharePoint site. The sp:View type contains the signature shown in Table F-65.
The sp:View type defines the child node types shown in Table F-66.
Table F-66 Child Node Types of View
| Name | Declared Node Type | Auto-created | Mandatory | Allows Same Name Siblings | Protected | Default Primary Node Type | Required Primary Types |
|---|---|---|---|---|---|---|---|
|
sp:Field |
sp:View |
Yes |
Yes |
No |
Yes |
sp:Field Collection |
sp:Field Collection |
The sp:View type defines the properties shown in Table F-67.
Table F-67 View Properties
| Name | Required Type | Auto-Created | Default Value | Mandatory | Multiple | Protected | Description |
|---|---|---|---|---|---|---|---|
|
aggregations |
String |
No |
- |
No |
No |
Yes |
Contains field references for one or more aggregate or total columns used in a view. |
|
aggregationStatus |
String |
No |
- |
No |
No |
Yes |
Contains a string that specifies whether aggregate or total columns are used in the view. |
|
baseViewID |
String |
No |
- |
Yes |
No |
Yes |
Contains the Id of the base view for the view. |
|
defaultView |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains the value that specifies whether the view is the default view. |
|
editorModified |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains the value that indicates whether the view was modified by using an HTML editor. |
|
formats |
String |
No |
- |
Yes |
Yes |
Yes |
Contains definitions for column and row formatting used in a datasheet view. |
|
groupByFooter |
String |
No |
- |
Yes |
No |
Yes |
Contains the definition of the Group By footer that is used in the view. |
|
groupByHeader |
String |
No |
- |
Yes |
No |
Yes |
Contains the definition of the Group By header used in the view. |
|
hidden |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains the hidden flag. |
|
htmlSchemaXml |
String |
No |
- |
Yes |
No |
Yes |
Contains the entire schema for the view. |
|
moderationType |
String |
No |
- |
Yes |
No |
Yes |
Contains the moderation type for the view. |
|
name |
String |
No |
- |
Yes |
No |
Yes |
Contains the GUID that identifies the view. |
|
orderedView |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains the value that indicates whether users can reorder items through the user interface. |
|
paged |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains the value that specifies whether the list supports displaying more items by adding more pages. |
|
personalView |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains the value that indicates whether the view is personalized. |
|
query |
String |
No |
- |
Yes |
No |
Yes |
Contains an XML string representing the query for the view. |
|
readOnlyView |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains the value that indicates whether the view is read-only. |
|
recurrenceRowset |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains the value that specifies whether the view supports recurrence rowsets. |
|
rowLimit |
Long |
No |
- |
Yes |
No |
Yes |
Contains the maximum number of items to return in a view. |
|
rowLimitExceeded |
String |
No |
- |
Yes |
No |
Yes |
Contains the alternate rendering when the rowLimit is exceeded. |
|
schemaXml |
String |
No |
- |
Yes |
No |
Yes |
Contains the schema that defines the view. |
|
scope |
String |
No |
- |
No |
No |
Yes |
Contains the recursive scope for the view of a document library. |
|
styleId |
String |
No |
- |
Yes |
No |
Yes |
Contains the Id of the view style for the view. |
|
threaded |
Boolean |
Yes |
False |
Yes |
No |
Yes |
Contains the value that indicates whether the view is threaded. |
|
title |
String |
No |
- |
Yes |
No |
Yes |
Contains the display name for the view. |
|
toolbar |
String |
No |
- |
Yes |
No |
Yes |
Contains the toolbar for the view. |
|
toolbarType |
String |
No |
- |
Yes |
No |
Yes |
Contains the type of the toolbar for the view. |
|
type |
String |
No |
- |
Yes |
No |
Yes |
Contains the type of the view. |
|
url |
String |
No |
- |
Yes |
No |
Yes |
Contains the URL of the main page that includes the view. |
|
viewBody |
String |
No |
- |
Yes |
No |
Yes |
Contains the body of the view. |
|
viewEmpty |
String |
No |
- |
Yes |
No |
Yes |
Is displayed when the query returns no list data for the view. |
|
viewFooter |
String |
No |
- |
Yes |
No |
Yes |
Contains the footer area for the view. |
|
viewHeader |
String |
No |
- |
Yes |
No |
Yes |
Contains the header area for the view. |
The sp:ListItem is a JSP type of SharePoint's SPListItem class. It represents an item, or row in a list. It contains the signature shown in Table F-68.
Table F-68 List Item Signature
| Type | Value |
|---|---|
|
Namespace |
sp |
|
Local name |
ListItem |
|
Super types |
sp:Object nt:hierarchyNode |
The sp:ListItem type defines child node types shown in Table F-69.
Table F-69 Child Node Types of List Item
| Name | Declared Node Type | Auto-created | Mandatory | Allows Same Name Siblings | Protected | Default Primary Node Type | Required Primary Types |
|---|---|---|---|---|---|---|---|
|
sp:Attachment |
sp:ListItem |
No |
No |
No |
Yes |
sp:Attachment |
sp:Attachment |
|
sp:ListItem |
sp:ListItem |
No |
No |
No |
Yes |
sp:ListItem |
sp:ListItem |
The sp:ListItem type does not define common properties. All properties are built automatically for each type of list item.
This section describes the following types of JCR nodes:
The sp:Folder type represents the folder in the SharePoint document library. The sp:Folder type contains the signature shown in Table F-70.
The sp:Folder type defines child node types shown in Table F-71.
Table F-71 Child Node Types of Folder
| Name | Declared Node Type | Auto-created | Mandatory | Allows Same Name Siblings | Protected | Default Primary Node Type | Required Primary Types |
|---|---|---|---|---|---|---|---|
|
* |
sp:Folder |
No |
No |
No |
No |
sp:ListItem |
sp:ListItem |
|
* |
sp:Folder |
No |
No |
No |
No |
sp:Folder |
sp:Folder |
|
* |
sp:Folder |
No |
No |
No |
No |
sp:FileItem |
sp:FileItem |
|
* |
sp:Folder |
No |
No |
No |
No |
sp:Attachment |
sp:Attachment |
The sp:Folder type defines the properties shown in Table F-72.
The sp:File type represents the file in the SharePoint document library. The sp:File type contains the signature shown in Table F-73.
The sp:File type does not define any child node types and properties.
The sp:Attachment type represents the attachment of list item. The sp:Attachment type contains the signature shown in Table F-74.
Table F-74 Attachment Signature
| Type | Value |
|---|---|
|
Namespace |
sp |
|
Local name |
Attachment |
|
Super types |
sp:Object nt:file |
The sp:Attachment type does not define child node types and properties.
This section describes node types for the Oracle WebCenter adapter for EMC Documentum. It contains the following subsections:
The Oracle WebCenter adapter for EMC Documentum uses its own namespace for the repository node types. This namespace is denoted by prefix dctm in the following descriptions.
All of the registered Documentum types are available through the JCR adapter by means of a simple type mapping mechanism. The Oracle WebCenter adapter for EMC Documentum uses the prefix dctm as a default. If the default is used already, the rule dctm(n) namespace will be used, where n = integer.
Table F-75 lists the main node types that show how the document hierarchy is mapped to types, that is, the content mapping classes to map Documentum objects to JCR node types.
Table F-75 Content Mapping Classes to Map Documentum Objects to JCR Node Types
| JCR Type | Description |
|---|---|
|
dctm:dmr_content |
Represents a binary data of document content. |
|
dctm:dm_document |
Base class for all Documentum documents. |
|
dctm:dm_folder |
Represent a list of folders and documents. (Super class for cabinet) |
|
dctm:dm_root |
Represents an root folder or set of cabinets, depends of configuration. |
All JCR node types have one or several super types. Table F-76 lists Documentum node types and its super types.
Table F-76 Documentum Node Types and Super Types
| JCR Types | JCR Super Types |
|---|---|
|
dctm:dm_acl |
dctm:dm_base, mix:referenceable |
|
dctm:dm_activity |
dctm:dm_sysobject, dctm:dm_base, mix:referenceable |
|
dctm:dm_aggr_domain |
dctm:dm_domain, dctm:dm_base, mix:referenceable |
|
dctm:dm_alias_set |
dctm:dm_base, mix:referenceable |
|
dctm:dm_assembly |
dctm:dm_base, mix:referenceable |
|
dctm:dm_audittrail |
dctm:dm_base, mix:referenceable |
|
dctm:dm_audittrail_acl |
dctm:dm_audittrail, mix:referenceable |
|
dctm:dm_audittrail_group |
dctm:dm_audittrail, mix:referenceable |
|
dctm:dm_base |
mix:referenceable, mix:referenceable |
|
dctm:dm_blobstore |
dctm:dm_store, mix:referenceable |
|
dctm:dm_builtin_expr |
dctm:dm_expression, mix:referenceable |
|
dctm:dm_business_pro |
dctm:dm_sysobject, mix:referenceable |
|
dctm:dm_cabinet |
dctm:dm_folder, mix:referenceable |
|
dctm:dm_cond_expr |
dctm:dm_func_expr, mix:referenceable |
|
dctm:dm_cond_id_expr |
dctm:dm_cond_expr, mix:referenceable |
|
dctm:dm_dd_info |
dctm:dm_base, mix:referenceable |
|
dctm:dm_display_config |
dctm:dm_base, mix:referenceable |
|
dctm:dm_docbaseid_map |
dctm:dm_base, mix:referenceable |
|
dctm:dm_decision |
dctm:dm_sysobject, mix:referenceable |
|
dctm:dm_distributedstore |
dctm:dm_store, mix:referenceable |
|
dctm:dm_document |
nt:file, dctm:dm_sysobject, mix:referenceable, rep:AccessControllable |
|
dctm:dm_domain |
dctm:dm_base, mix:referenceable |
|
dctm:dm_aggr_domain |
dctm:dm_domain, mix:referenceable |
|
dctm:dm_dump_record |
dctm:dm_base, mix:referenceable |
|
dctm:dm_expression |
dctm:dm_base, mix:referenceable |
|
dctm:dm_builtin_expr |
dctm:dm_expression, mix:referenceable |
|
dctm:dm_func_expr |
dctm:dm_expression, mix:referenceable |
|
dctm:dm_literal_expr |
dctm:dm_expression, mix:referenceable |
|
dctm:dm_format |
dctm:dm_base, mix:referenceable |
|
dctm:dm_fulltext_index |
dctm:dm_base, mix:referenceable |
|
dctm:dm_group |
dctm:dm_base, rep:Group mix:referenceable |
|
dctm:dm_id_range |
dctm:dm_base, mix:referenceable |
|
dctm:dm_extern_file |
dctm:dm_extern_store, mix:referenceable |
|
dctm:dm_extern_free |
dctm:dm_extern_store, mix:referenceable |
|
dctm:dm_extern_store |
dctm:dm_store, mix:referenceable |
|
dctm:dm_extern_url |
dctm:dm_extern_store, mix:referenceable |
|
dctm:dm_federation |
dctm:dm_sysobject, mix:referenceable |
|
dctm:dm_filestore |
dctm:dm_store, mix:referenceable |
|
dctm:dm_folder |
nt:folder, dctm:dm_sysobject, mix:referenceable, rep:AccessControllable |
|
dctm:dm_foreign_key |
dctm:dm_relation_type, mix:referenceable |
|
dctm:dm_format_preferences |
dctm:dm_document, mix:referenceable |
|
Dctm:dm_sysobject |
dctm:dm_base, mix:referenceable |
The Oracle WebCenter adapter for EMC Documentum presents the content hierarchically, in a similar way to the Documentum Web Console. The Documentum workspace root, dctm:dm_root contains list of administrative folders and cabinets, dctm:dm_cabinet. Each cabinet contains a hierarchy of system objects.
The JCR adapter supports Documentum virtual documents. A virtual document appears in the JCR hierarchy as a document node with child document nodes corresponding to the associated documents or virtual documents. In addition, the child document nodes also appear as document nodes in the parent folder that contains the virtual document. The dctm:r_is_virtual_doc property indicates if a document is a virtual document.
The Documentum access control permissions are mapped to JCR permissions as shown in Table F-77.
Table F-77 Permission Mapping
| Documentum Permission | Description | JCR Permission |
|---|---|---|
|
Browse |
Read and browse folders |
Read |
|
Read |
Read and browse folders and content |
Read |
|
Relate |
Make references for documents |
Read |
|
Version |
View document history |
Read |
|
Write |
Modify a document |
Read, Write |
|
Delete |
Read, modify, or delete |
Write, Remove |
The Oracle WebCenter adapter for EMC Documentum caches information retrieved from the Documentum repository. It periodically checks for content updates, such as modified, created, or deleted Documentum objects as well as user and permission updates. The frequency with which this cache is updated can be set by configuring the Refresh Interval adapter parameter. See Table 5-14 for more information.