|
Checks in the specified file to the SharePoint repository.
If a document library allows updating both the minor and major
versions, then selecting the Update Major Version option updates
the major version of the document. If not, only the minor version
of the document is updated.
If a document library does not allow any major/minor version
support on documents, selecting the Update Major Version option
does not affect the check-in operation.
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 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 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.
File Information properties
Properties to specify the file to check in.
Select file to check in
A
string
value that specifies
the relative URL of the file to check in. Do not append a forward
slash to the path. If you provide a literal value, type the path
or click Select File to view existing files and folders at the selected
document library.
Version Update Settings properties
Specifies how to update the version of the document in
the repository.
Update Major Version
(Optional) A
boolean
value that specifies
whether to update the major version for the document. This setting
must match the setting at your SharePoint server's document library
for all documents that are being checked in. If these versions do
not match, the document is not checked in. Default value is
false
.
Comment
(Optional)
A
string
value that contains
the description that you can enter when checking the file in.
Result properties
A
boolean
value that indicates
whether the check-in operation is successful. A
true
indicates
that check-in is successful;
false
if the operation
failed.
|
|
|
