IDOL Category Component 24.4
IDOL Category Component Help

# Automatically Email Agent and Channel Results

You can configure the IDOL Community component to automatically email users the results that their agents and channels produce. You can schedule the emailing of agent and channel results and optionally store lists of sent results to prevent the duplication of email.

To set up automatic email of agent and channel results

1. Open the IDOL Community component configuration file in a text editor.

2. Find the `[UserCustom]` section. This section lists all the custom processes that Community runs.

3. Check whether the `[UserCustom]` section lists a section for emailing. If it does not, add one. For example:

       [UserCustom]
       0=Email

4. Create a configuration file section for the emailing process that you listed. For example:

       [Email]

5. In your new section, set `Library` to `InstallDir/community/modules/user_email`. Set `RunMailer` to `True` and `DefaultSendEmail` to `True` to enable the Community mailing operation.

6. Specify a `TestUser`. While you are configuring mailing, Community sends all mail to the `TestUser` email address.

7. If you are using a proxy server, specify the `ProxyHost`, `ProxyPort`, your `ProxyUsername`, and your `ProxyPassword`.

8. Use `SMTPHost` and `SMTPPort` to specify the details of your mail server.

9. Use `Cycles` and `Interval` to determine how many times the mailing operation must run, and the time span that you want to elapse between the sending of email. Set `StartTime` to `now`, so that you can test the mailing operation immediately when you start Community.

10. Set `Retries` to the number of times that Community attempts to connect to its agent index before it times out. Set `TimeoutMS` to how long each of these attempts can take.

11. Use `From`, `FromHost`, and `FromName` to set the details to display as the sender of email that the mailing operation sends. You can also use `FromField` and `FromNameField` to specify a user field that contains the sender details.

12. Specify the `DefaultSubject` to display as the mail subject line.

13. Use `EmailXSLTemplate` to specify the template to use for the email. The `DefaultEmailFormat` and `DefaultEmailResultsType` settings allow you to specify the email format and whether to send results individually or in sets.

14. Set `DefaultAddSetToReadDocuments` to `True` to automatically add the documents in the email to the list of documents that the user has viewed. Set `DefaultExcludeReadDocuments` to `True` to exclude documents that the user has recently viewed from the email (so that they receive each result only once).

    NOTE: You must set `DRETemplateReferenceStart` and `DRETemplateReferenceEnd` in the `[Agent]` section to ensure that Community can extract document references and determine if they were viewed.

15. To include channel results in the email that the mailing operation sends, configure the following parameters:

    - `ClassificationServerHost`. The host name or IP address of the IDOL Category component to use.
    - `ClassificationServerPort`. The ACI port of the IDOL Category component.

    - `ClassificationServerXSLTemplate`. The template to use to display channel results.

    - `ClassificationServerNumResults`. The maximum number of channel results to include in the email.

    - `ClassificationServerThreshold`. The quality of channel results to include in the email.

    - `ClassificationServerParams`. Parameters that must be included in the channels query that the mailing operation sends to the category index.

    - `ClassificationServerValues`. The values of the specified `ClassificationServerParams` parameters.

    - `ClassificationServerRetries`. The number of times that the mailing operation attempts to connect to the category index.

    - `ClassificationServerTimeout`. Specifies how long each of the `ClassificationServerRetries` can take, before the mailing operation times out.

    NOTE: Users receive channel results only for categories that they subscribe to. You can subscribe a user to one or more categories by sending a `UserEdit` action to Community. Use the `CategorySubscribe` parameter to specify the categories whose results you want to mail to the user. (You can unsubscribe a user by using a `UserEdit` action with the `CategoryUnsubscribe` parameter set to the categories whose results must no longer be included in the email to the user.)

16. To minimize the impact that the mailing operation has on your system resources, you can set `SleepBetweenRequests` and `MaxEmailsPerUser` to values that are appropriate for your environment.

17. Save the IDOL Community component configuration file and restart Community. The mailing operation starts immediately because you set `StartTime` to `now`. It sends mail to the `TestUser` address that you specified. Ensure that the mail process works smoothly.

18. Make any adjustments to your settings that you need, then save the configuration file again and restart the IDOL Community component. You can enable `VerboseLogging` if you experience problems with the mailing operation.

When you are satisfied with the mailing operation:

1. Open the IDOL Community component configuration file in a text editor.

2. Find the `[UserCustom]` section.

3. Delete the email address that you specified for `TestUser`, and set `StartTime` to the time when you want the mailing operation to start.

4. Save and close the configuration file.

5. Restart the IDOL Community component for your changes to take effect.

Related Topics

- Edit IDOL Configuration Files

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 IDOL Category Component 24.4

Topic Title: Automatically Email Agent and Channel Results