|
Retrieves a document from a IBM FileNet
repository.
For information about the General and Route Evaluation property
groups, see
Common operation properties
.
Login Settings properties
Login settings for invoking the Content Repository Connector
for IBM FileNet service.
Login Mode
A
com.adobe.livecycle.ibmfilenetcontentrepositoryconnector.client.type.impl.LoginSettings
value
that represents how the operation will log in to the FileNet repository.
Valid values are
INVOCATION_CONTEXT
(Use Credentials
from process context),
USER_CREDENTIALS
(Use User
Credentials), and
TOKEN
(Use FileNet Credentials
Token).
-
Use Credentials from process context:
-
Uses the AEM forms User Management credential from the process
context for the FileNet authentication.
-
Use User Credentials:
-
Uses the User Name and Password properties to authenticate
with FileNet. Ensure that the user name is valid for the FileNet
P8 Content Engine that is specified in administration console.
-
Use FileNet Credentials Token:
-
Uses the FileNet Credentials Token property to authenticate
with the FileNet Content Engine. This login token must be valid
in the current FileNet session.
User Name
A
string
value that specifies
the account name to use when connecting to the FileNet object store.
This
field is used only when the Login Mode property is set to
USER_CREDENTIALS
(Use
User Credentials) or
TOKEN
(Use FileNet Credentials Token).
Password
A
string
value that specifies
the password that is associated with the account name that is specified
in the User Name property to use when connecting to the FileNet
object store.
This field is used only when the Login Mode
property is set to
USER_CREDENTIALS
(Use User Credentials).
FileNet Credentials Token
A
string
value that represents
the location of an existing FileNet credentials token.
This
field is used only when the Login Mode property is set to
TOKEN
(Use
FileNet Credentials Token).
Document Settings properties
Specifies the repository properties for the document to
retrieve.
Object Store
A
string
value that represents
the name of the IBM FileNet repository. You can choose from the
list of available object stores from your current FileNet Content Engine
defined in administration console. (See AEM forms administration
help.)
Document GUID Or Path
A
string
value that indicates
either the document GUID or the folder location within the object
store.
If you provide a literal value, type the path or click
Browse to select the folder from the IBM FileNet repository.
When
typing the folder path, use the following rules:
-
Do
not include the object store name in the folder path.
-
Use a forward slash (/)to separate folder names if you specify
a folder location, as shown in this example:
/[FolderPath]/[documentName]
Meta-Data properties
Specifies document metadata properties for the retrieved
document.
Document Class Type
(Optional) A
string
value that represents
the FileNet object type to retrieve from the repository. The value
specified in this property is used to populate the map value in
the Property Mapping Table property. This action enables you to assign
values from process variables to attributes for the document class
type.
If you provide a literal value, type the value that
represents the document class type.
Note:
When
no value is provided, no attributes are populated in the
map
value
in the Property Mapping Table property.
Property Mapping Table
A
map
value for mapping attributes
to process variable values. The attributes are available only when
a value is specified in the Document Class Type property. The process
variables that you map to attributes must be the same data type.
For example, if an attribute is a string, it must be mapped to a
process variable of data type string. The name of an attribute is
used as the key. During document retrieval, the mapped process variables
is set with the value of the corresponding attributes from the document.
If
you provide a literal value, the list of attributes in the table
is based on the item you specified in the Document Class Type property.
You can select a process variable from the Value column to assign
to each attribute in the Name column.
Note:
No
value is provided for this property when no value exists in the
Item Type property.
Results properties
Specifies the properties for the document that is retrieved
from the IBM FileNet repository.
Retrieve Content Result
An
object
value that stores
the content properties that are specified in the Results property
group.
Document Contents
A
document
value that contains
the document content.
Document ID
A
string
value that indicates
the ID for the document.
Document Major Version
A
string
value that specifies
the major version number of the document.
Document Minor Version
A
string
value that specifies
the minor version number of the document.
Document Class Type
A
string
value that indicates
the FileNet object type for the document.
Document Mime Type
A
string
value that indicates
the MIME type of the document.
Document Content Type
A
string
value that indicates
the FileNet content type for the document.
Name of the Document Creator
A
string
value that indicates
the user name of the original author of the document.
Document Creation Date
A
date
value that indicates
when the original version of the document was created.
Last Document Modifier
A
string
value that specifies
the user name of the last person to change the document.
Last Document Modification Date
A
date
value that indicates
when the document was last changed.
Property Name Value Map
A
map
value that contains values
of attributes that are specified during document retrieval. You
can also map individual attributes to process variables in the Meta-Data
property group.
For information about retrieving values from
a map, see
Accessing data in data collections
.
|
|
|
