Community

Allows you to view a community. The community is a collection of users who have one or more agents or profiles that match specified query Text, or that match agents or profiles of the specified user.

NOTE:

For the Community action to work correctly, you must have a reasonable number of users on your system, with a reasonable number of profiles and agents.

Example

http://12.3.4.56:9000/action=Community&UserName=Administrator

This action uses port 9000 to request the community agents and profiles that are similar to the agents and profiles of the Administrator user from HPE Community Component, which is situated on a machine with the IP address 12.3.4.56).

Parameters

Parameter Description Required
AgentName The name of the agent to match. See Comments
Agents Whether agents can be used by the action.  
AgentsFindAgents Whether agents can be matched by agents.  
AgentsFindProfiles Whether agents can be matched by profiles.  
DeferLogin Whether user authentication is managed by another system.  
DREQueryParameter A Query action parameter to add to the action.  
EmailAddress The e-mail address of the user.  
ExpandQuery Whether to expand the query to include similar terms.  
FieldFieldName Creates a field associated with the specified user.  
FindNamedArea Restricts matching profiles to the specified area.  
NamedArea Restricts profiles for querying to the specified area.  
OutputEncoding The encoding of text that the action returns.  
PID The ID of a profile to query the community with. See Comments
Profile Whether the action can match profiles.  
ProfileMaxNumber The maximum number of profile results to return.  
ProfileMaxScore The maximum profile relevance score to return.  
ProfileMinScore The minimum profile relevance score to return.  
ProfilesFindAgents Whether to match profiles against agents.  
ProfilesFindProfiles Whether to match profiles against profiles.  
Security Creates a security field for the user to store the security details for the user.  
Text Query text. See Comments
UID The ID of the user to match agents and profiles for. See Comments
UserFieldName The name of a field that must match in a user’s profile.  
UserFieldValue The value of a field that must match in a user’s profile.  
UserName The name of a user to match agents and profiles for. See Comments

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.

Comments

You must use one of Text, PID, UID, or UserName to specify the community that you want to find. If you specify multiple values, Text takes priority.

The Community action prints the user name and agent name of agent results by default.


_HP_HTML5_bannerTitle.htm