This operation updates the properties of the specified
document. Document content is not considered as a document's property.
To update the document content, use the
Set Document Content operation
operation instead.
For information about the General and Route Evaluation property
groups, see
Common operation properties
.
Login Settings properties
Login settings for invoking the Connector for Microsoft SharePoint
service.
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 LiveCycle ES2.5 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 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 for which the properties
are to be updated.
File URL
A
string
value that specifies
the file for which the properties are to be updated. Do not append
a forward slash to the path. If you provide a literal value, click Select
File to view existing files/folders at the selected document library.
If the file does not exist, an exception is thrown.
Document Properties properties
Properties to apply to the specified document.
Properties
A
map
value that contains the
document properties (name—value pairs) to apply to the specified
document.
Use Same Transaction
A
boolean
value that specifies
whether all the document properties are updated in a single transaction.
As a result, either all or none of the properties are set. If deselected,
a best attempt to set each property is made and all those properties
which were correctly stated is set. Default:
true
.
If you provide a literal value, select or deselect the Use Same
Transaction option.
|
|
|