Index
Indexes the agents and profiles of all users or a specified user into the Agentstore component agent index. The Community component indexes agents and profiles by default, but Index
allows you to index them into a new index, for example, to move your agent index to a different Agentstore component.
NOTE: This is an administrative action that can be sent only by users that belong to an authorization role that allows the Admin
standard role, or which enables the action explicitly. See Authorization Roles Configuration Parameters.
Example
http://12.3.4.56:9030/action=Index&FileName=Users.xml
This action indexes the agents and profiles of all users in Community.
Optional Parameters
This action accepts the following optional parameters.
Parameter | Description |
---|---|
DeleteExisting | Removes existing agents and profiles from the Agentstore component before indexing. |
EmailAddress | The e-mail address of the user. |
FieldFieldName | Creates a field for the user. |
Security | The new user’s security field. |
UID | The ID of the user whose agents and profiles you want to index. |
UserName | The name of the user whose agents and profiles you want to index. |
This action accepts the following standard ACI action parameters.
Parameter | Description |
---|---|
ActionID | A string to use to identify an ACI action. |
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. |