Portal Document Manager Access builder data services

Portlet Factory, Version 6.1.2

Portal Document Manager Access builder data services

The builder provides traditional create, retrieve, update, and delete operations on nodes in the Content Model.
The services are described in the following table.

Service Description Input parameters Output parameters
findDocuments Find documents or document containers in the Content Model

criteria

Specifies the search criteria from the Search Criteria section in the Builder Call Editor.

results

Container to hold results from a search.

getDocument Retrieves a document or document container from the Content Model

criteria

Specifies the document id of the document to fetch.

document

Holds the detail of the document being requested.

createDocument Create a new document or document container in the Content Model

criteria

Specifies the parent id (Folder or DocumentLibrary) and the name of the parent collection property.
The value of the collection property depends on the document type you create. For example, if you create a Folder, the parent collection property is folders. If you create a Document, the parent collection property is documents. Refer to the Portal Document Library Explorer sample model for implementation details.

document

Contains the data of the new document.

createDocumentWithCriteria Create a new document or document container in the Content Model
This method is the same as createDocument except that the inputs are wrapped in a single schema-typed variable.

criteria

Specifies the parent id, name of parent collection property, and the data of the new document.

deleteDocument Delete a document or document container in the Content Model

criteria

Specifies the unique document id for the document to delete (Variable: builder_nameGetCriteria)

updateDocument Update a document or document container in the Content Model
Note: The Content Model automatically manages some properties. When metadata or document content changes and updateDocument() is called, be sure to call getDocument() again. This ensures the buildernameDetail variable is populated with the latest values stored in the repository.

document

Holds the updated data to be stored in the Content Model. (Variable: buildernameDetail)

Parent topic: Portal Document Manager Access builder

Library | Support |

Service	Description	Input parameters	Output parameters
findDocuments	Find documents or document containers in the Content Model	criteria Specifies the search criteria from the Search Criteria section in the Builder Call Editor.	results Container to hold results from a search.
getDocument	Retrieves a document or document container from the Content Model	criteria Specifies the document id of the document to fetch.	document Holds the detail of the document being requested.
createDocument	Create a new document or document container in the Content Model	criteria Specifies the parent id (Folder or DocumentLibrary) and the name of the parent collection property. The value of the collection property depends on the document type you create. For example, if you create a Folder, the parent collection property is folders. If you create a Document, the parent collection property is documents. Refer to the Portal Document Library Explorer sample model for implementation details. document Contains the data of the new document.
createDocumentWithCriteria	Create a new document or document container in the Content Model This method is the same as createDocument except that the inputs are wrapped in a single schema-typed variable.	criteria Specifies the parent id, name of parent collection property, and the data of the new document.
deleteDocument	Delete a document or document container in the Content Model	criteria Specifies the unique document id for the document to delete (Variable: builder_nameGetCriteria)
updateDocument	Update a document or document container in the Content Model Note: The Content Model automatically manages some properties. When metadata or document content changes and updateDocument() is called, be sure to call getDocument() again. This ensures the buildernameDetail variable is populated with the latest values stored in the repository.	document Holds the updated data to be stored in the Content Model. (Variable: buildernameDetail)