Retrieve Document Content operation

Login Settings properties
Site and Document Library Information properties properties
Document Identification properties
Result properties
Exceptions

Retrieves the contents of the specified document as a document object. No document properties are fetched in the process. To fetch document properties, use the Get Properties operation operation instead. This operation automatically determines mime-type of the document from the document extension. However, if the extension is missing, the default mime-type of the document is set to application\octet-stream .

For information about the General and Route Evaluation property groups, see Common operation properties .

Login Settings properties

Login Mode

A com.adobe.livecycle.crc.sharepoint.client.types.LoginSettings value that represents how the operation will be authenticated with SharePoint. Valid values are INVOCATION_CONTEXT (Use Credentials from process context) and USER_CREDENTIALS (Use User Credentials).

If you provide a literal value, select one of the following options:

Use Credentials from process context:: Uses the AEM forms User Management credential from the process context for SharePoint authentication.
Use User Credentials:: Uses the specified User Name and Password properties to authenticate with the SharePoint server.

Hostname

(Optional) A string value that specifies the hostname of the machine which hosts Microsoft SharePoint. You can also use the Hostname field to connect with any web application running on a port number other that 80 by specifying the hostname and port number in the format [hostname]:[port number] .

This field is only used when Login Mode is set to 'Use User Credentials'. No default is provided.

User Name

(Optional) A string value that specifies the user name to be used to connect with the SharePoint server. If the user account is of Windows local users or users configured using Forms Authentication on the SharePoint site, only the user name is required. However, domain users for Windows Authentication enabled sites must provide both the domain name and login name in the format domainName\LoginName .

This field is only used when the Login Mode is set to 'Use User Credentials'. No default is provided.

Password

(Optional) A string value that specifies the password to be used to connect with the SharePoint server. This field is only used when Login Mode is set to 'Use User Credentials'. No default is provided.

Domain

(Optional) A string value that specifies the domain in which the SharePoint server is present. This field is only used when Login Mode is set to 'Use User Credentials'.

Site and Document Library Information properties properties

Properties to specify the SharePoint site and document library.

Site URL

A string value that specifies the URL of the SharePoint site. Do not append a forward slash to the path. If you provide a literal value, type the URL of the SharePoint site or click Sites to browse existing SharePoint sites on the host machine. No default is provided.

Document Library Name

A string value that specifies the document library. If you provide a literal value, type the path or click Document Library to select the document library from the Microsoft SharePoint repository. Do not include the repository name in the folder path.

Document Identification properties

Properties to specify the document of which the content is to be retrieved.

Select File

A string value that specifies the file from which the content is to be retrieved. Do not append a forward slash to the path. You can browse to view all existing files/folders at the selected document library. If the file does not exist, an exception is thrown.

Result properties

A document object that represents the contents of the specified document.

Exceptions

This operation can throw a RepositoryException exception.