IDOL Server 24.4
IDOL Server Help

# 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.

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

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

## Example

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

This action requests the community agents and profiles that are similar to the agents and profiles of the Administrator user.

## Required Parameters

You must set at least one of the following parameters.

Parameter | Description
--- | ---
AgentName | The name of the agent to match.
PID | The ID of a profile to query the community with.
Text | Query text.
UID | The ID of the user to match agents and profiles for.
UserName | The name of a user to match agents and profiles for.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
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.
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.
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.

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.

Copyright 2024 Open Text
Version 24.4 | Last updated September 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Server 24.4

Topic Title: Community