View
The View
action is a synchronous action that retrieves a single file from a repository through an appropriate connector. You can use the action to view a particular item in a managed repository.
To specify the item that you want to view, set the Identifier
action parameter. The Distributed Connector queries IDOL Server to retrieve the value of the AUTN_GROUP
field from the document, so that it can send the View
action to the correct connector group. You can improve performance by setting the AUTN_GROUP
parameter, because when this parameter is set the Distributed Connector does not need to query IDOL.
Type: Synchronous
Parameters
Parameter Name | Description | Required |
---|---|---|
AnyLanguage
|
Sets the value of the AnyLanguage parameter, used when queries are sent to IDOL. |
|
AUTN_GROUP | The connector group to send the action to. | |
Config
|
An optional Base64 encoded configuration file, to override the connector configuration file. | |
Identifier
|
The document identifier of the item to view. The view action accepts only a single identifier. | Yes |
IdentifierField
|
When the Distributed Connector queries IDOL server to find documents, it expects each document to have an identifier in the AUTN_IDENTIFIER field. The identifier is required so that a connector can retrieve the document from the repository. If the identifier is stored in a different field, use this parameter to specify the name of the field. This parameter is ignored when you set AUTN_GROUP . |
|
NoACI
|
This parameter sets the value of the
|
|
TaskSections | The name of the task in the connector configuration file to use to retrieve the item from the repository. This value is passed to the connector that performs the action. |
Any additional parameters that you specify are passed to the connector that performs the action.
Example
/action=view&Identifier=...
/action=view&Identifier=...&AUTN_GROUP=SharepointConnectors
Response
The response is the binary content of the file, unless you have specified NoACI=false
.
If you specify NoACI=false
, XML data is returned. For example:
<autnresponse> <action>VIEW</action> <response>SUCCESS</response> <responsedata> <mime-type>application/octet-stream</mime-type> <filename>filename.bin</filename> <content>[Base64 encoded file content]</content> </responsedata> </autnresponse>