Queries the IDOL Server data index with an agent and returns the agent results.
http://12.3.4.56:9000/action=AgentGetResults&UserName=Administrator&AgentName=Global+Warming
This action uses port 9000
to request the results of the Global Warming
agent for the Administrator
user from IDOL Community Component, which is situated on a machine with the IP address 12.3.4.56
.
Parameter | Description | Required |
---|---|---|
AddSetToReadDocuments | Whether to add agent results to the list of recently viewed documents. | |
AgentBoolean | Include Boolean restrictions in the query. | |
AgentField | An agent field whose value determines if the agent is included. | |
AgentFieldText | Include FieldText restrictions in the query. |
|
AgentName | The name of the agent to query. | see Comments |
AID | The agent ID of the agent to query. | see Comments |
DREQueryParameter | Add Query action parameters. |
|
EmailAddress | The e-mail address of the user. | |
ExcludeReadDocuments | Whether to exclude read documents from results returned to the user. | |
FieldFieldName | A field for the new agent. | |
InputEncoding | The encoding of the AgentName, UserName, and ViewingUserName values. | |
OutputEncoding | Converts the encoding of the text that the action returns. | |
Security | A field for the user to store user security details. | |
UID | The ID of the user that the agent belongs to. | see Comments |
UserDetails | Whether to return user details with the results. | |
UserFieldMatch | Restricts which user fields are displayed. | |
UserName | The user name of the user that the agent belongs to. | see Comments |
ViewingUserName | The user name of a user that can view the agent results although they are not the owner of the agent. |
This action accepts the following standard ACI action parameters.
Parameter | Description |
---|---|
ActionID | A string to use to identify an ACI action. |
EncryptResponse | Encrypt the output. |
FileName | The file to write output to. |
ForceTemplateRefresh | Forces the server to load the template from disk. |
Output | Writes output to a file. |
ResponseFormat | The format of the action output. |
Template | The template to use for the action output. |
TemplateParamCSVs | A list of variables to use for the specified template. |
You must set one of the following parameter combinations:
|