Skip to main content
Version: 4.1

Install and configure

The page provides instructions on installing and configuring Evan (formerly Evelyn AMM). For data on the WorkFusion platform compatibility, refer to the release notes.

Meet requirements​

Hardware​

Evan runs on the standard Work.AI hardware configuration as documented in the Hardware and OS guide.

ServerRecommended OSCPU (cores)RAM (GB)HDD (GB)
MasterRHEL 8.5832750
BEP AgentRHEL 8.5416150
AnalyticsWindows Server 20161632150
MS SQLWindows Server 20162/48/16500
  • RPA bots are not required for Adverse Media Monitoring.
  • High-availability environments require a Proxy server.

For the architecture deployment, refer to Install AI Agents | View architecture deployment.

Software​

AMM versionEnvironment topologyPlatform versionAutoML Worker configurationControl Tower Worker configurationJava Native Worker configuration
4.1.xstandard-6 topology (6/1 BEP Agents)10.2.9+1 CPU / 8 GB memory0.4 CPU / 2 GB memory0.4 CPU / 2 GB memory

Before installing AMM, make sure that your environment meets the requirements:

  • You have installed Work.AI v10.2.9+ and have the Control Tower and Analytics components enabled. For Work.AI, ODF 2 is installed automatically along with the system.
  • You have a bundle with the AMM Business Process and ML models.
  • You have received the credentials for the required watchlists or licenses for the external screening software to be integrated with AMM.
  • You have the Advanced Package Import and Import/Export [permissions in Control Tower]https://doc.workfusion.com/platform/docs/10.2.9/install/keycloak/role-management).

To check that ODF 2 is installed, do as follows:

  1. Log in to Control Tower, and click Advanced > Data Stores in the menu.

  2. In the list, find the Data Stores with the_odf_transactions and _odf_transactions_status names. ODF is installed on your instance if they are on the list.

If the Data Stores are missing, download ODF and save odf-install-package-yourversion.zip to your local workstation. To find the proper ODF installation package for your Work.AI version, refer to the Compatibility matrix documentation.

See performance data​

Adverse Media Monitoring leverages BEP servers that can be horizontally scaled for higher volumes.

The following table shows a sample of the volumes that can be expected when using the corresponding versions and configurations. These tests were performed with AMM 4.0 using Google API as the search provider. Note that throughputs may vary slightly, depending on the provider.

Test input: 280 entities file, with 1 entity = 20 articles

Number of BEP AgentsThroughputExecution time
12,036 articles/hour165 min
26,340 articles/hour53 min
38,000 articles/hour42 min
410,500 articles/hour32 min
510,800 articles/hour31 min
612,923 articles/hour26 min

Performance is measured per article across the total run to calculate throughput at the specific scaling level. Tests are run using the CSV upload method, and the system is monitored to identify long-running processes or performance bottlenecks.

Install Evan​

You can install Evan from the Solution Catalog or as a bundle. For details, see the Install AI Agents guide.

Configure Evan​

Once Evan is installed, you need to configure it before running for the first time.

You can configure multiple variations, or sets of parameters, for Evan. For example, you can set up a different data provider or a set of keywords per variation. For details, refer to Manage AI Agent variations.

API credentials for providers​

The following search providers are supported:

  • Google Custom Search API
  • Dow Jones Factiva Headlines
  • LexisNexis L&P Media
  • World-Check One
  • Thomson Reuters CLEAR Adverse Media
warning

You must acquire licenses and credentials for all providers, except for Google API. WorkFusion’s AMM solution includes access to Google API at no additional cost.

If you use Google API, your first step is to provide credentials. To do that, in a GCP-hosted environment, complete the instructions under the expand below.

Provide credentials for Google API

The Google API used for the AMM AI Agent is the Custom Search JSON API. You must provide credentials from the WorkFusion’s Developer account owned by the Cloud Ops team.

GCP requires unique credentials for each customer environment (for example, pre-production and production).

If you are not using Google Cloud, notify the WorkFusion Engineering and Product teams so that they can perform an audit to ensure there are no gaps for enablement.

To generate credentials, do the following:

  1. Log in to https://cloud.console.google.com.

  2. Ensure that the Custom Search JSON API is enabled.

  3. Navigate to the environment where you will use the API, for example, companyname-preprod.

  4. Click Create Credentials.

  5. In the Name field, specify a name for the API Key.

  6. In the Application restrictions group, select HTTP referrers and click Save.

  7. Navigate to OAuth consent screen. In the User Type group, select Internal and click Create.

  8. Navigate to Enabled APIs & services to view the key and copy the credentials.

  9. Add the key value in the Key field when setting a secret entry as described in Set up secret entries in Secrets Vault. The Value field is static.

To use providers other than Google API, the first step is to set up the credentials in Secrets Vault. For step-by-step instructions, refer to the Set up secret entries in Secrets Vault guide.

Configure SMTP credentials​

Evan emails analysts when results are ready and the final report is available. To enable the email notification, configure the SMTP credentials. Provide your own SMTP to ensure the respective security protocols are followed.

The sub-sections below describe how to configure the credentials and enable the email notification.

Update configuration in Data Store​

To update the configuration in the Data Store, do the following:

  1. Log in to Control Tower.
  2. On the main menu, navigate to Advanced and select Data Stores.
  3. Select uc_amm_configuration_v1 and specify the following:
NameValueExampleNotes
smtp.protocolSMTP_OVER_TLS/SMTP_OVER_SSL/SMTPSMTP_OVER_TLSTo be confirmed with WorkFusion.
smtp.hostsmtp.office365.comSet your host.
smtp.port123
smtp.replyToreplyTo@domain.comSet the email address to be shown as the sender.
smtp.authEnabledtrue/falsetrueSet to true if the SMTP server requires authentication. Otherwise, set to false.
smtp.credentialsAliasamm_smtp_credentialsConfigure only if smtp.authEnabled is set to true. Specify the name of the SMTP credentials in Secrets Vault. The value must match the Secrets Vault alias that contains the access credentials to the SMTP server.
smtp.fromreport@workfusion.comEnter the email address to be shown as the sender.
Set entry for SMTP credentials in Secrets Vault​
info

The step is needed only if smtp.authEnabled is set to true.

The key is the email address, and the value is the password. For detailed instructions, see Set up secret entries in Secrets Vault.

tip

Use a descriptive name, such as amm_smtp_credentials.

Configure proxy​

To configure a proxy, do the following:

  1. Log in to Control Tower.

  2. On the main menu, navigate to Advanced and select Data Stores.

  3. Select uc_amm_configuration_v1 and specify the following:

    NameExampleNotes
    proxy.hostproxy.customerdomain.comUse your proxy host.
    proxy.port9473Use your proxy port.
    proxy.credentialsAliasamm_proxy_credentialsSpecify the name of the proxy credentials in Secrets Vault. Configure only if the proxy requires authentication.

  4. If the proxy requires authentication, set up proxy credentials in Secrets Vault.

    The key is the username address, and the value is the password. For detailed instructions, see the Set up secret entries in Secrets Vault guide.

Input​

To set up the installed AI Agent, do the following:

  1. Log in to Control Tower, navigate to Digital Workers, find your newly installed AMM variation, and click the Prepare button.

  2. In the configuration window, on the Input step, indicate how you want the entities to be screened.

    The following options are available:

    • Retrospectively using a risk-based approach if you want the screening to be executed upon request. For further instructions, read Retrospective screening.

    • Proactively using event-based monitoring if you want screening to be automatically executed based on monitored events. For further instructions, read Proactive screening.

Retrospective screening​

To configure AMM to screen retrospectively, select one or more data providers in the Search provider field. You can configure the AI Agent to return search results from up to four providers at a time.

The following providers are supported out of the box:

If you select more than one provider, each appears as a distinct collapsible section below the Search provider field.

Review each section carefully to ensure all required parameters are configured correctly. Available parameters vary by provider. For detailed instructions, read the sections below.

Google API​

  • Google API Key alias: specify the corresponding Secrets Vault alias for Google API. Choose an existing alias or click Create Secrets Vault entry to set up one.

  • Use Scrape.do to download the articles that could not be retrieved: when enabled, Scrape.do will parse any website that your internal APIs failed to parse.

  • ScrapeDo Secret Vault alias: if you choose to utilize Scrape.do, specify the credentials for its licence. You can create a Secrets Vault entry on the go by clicking Create Secrets Vault entry.

  • Use browser rendering if a standard Scrape.do download attempt fails: when enabled, Scrape.do API will use different techniques to bypass the paywalls from some websites.

  • Article language: select the language of articles to search in. Any language is used by default. For the default option, you can specify the additional screening keyword settings:

    • Shared: the same set of keywords is to be used in articles across all languages.
    • Defined by keyword language: depending on the Keyword language setting, each language will have a specific set of keywords.

  • Keyword language: select the language of the keywords for the search.

  • Screening keywords: specify the keywords for the search or upload a CSV file with keywords. You can add a maximum of 28 words.

    The following keywords are added by default based on the article languages you select:

    • English:

      ACCUSE, ARREST, BRIBE, CONVICT, CORRUPT, COUNTERFEIT, CRIME, EMBEZZLEMENT, FRAUD, GUILT, ILLEGAL, INDICTMENT, INVESTIGATION, KICKBACK, MONEY LAUNDERING, NARCOTIC, PENALTY, SANCTION, SENTENCED, EVASION, TERRORIST, THEFT, TRAFFICKING, VIOLATION

    • Spanish:

      ACUSAR, ARRESTAR, SOBORNO, CORRUPTO, FALSIFICACIÓN, CRIMEN, MALVERSACIÓN, FRAUDE, CULPA, ILEGAL, ACUSACIÓN, INVESTIGACIÓN, CONTRAGOLPE, LAVADO DE DINERO, NARCÓTICO, MULTA, SANCIÓN, SENTENCIADO, EVASIÓN, TERRORISTA, ROBO, TRÁFICO, VIOLACIÓN

  • Enable keywords thesaurus: activate to look not only for exact keywords but also for their synonyms. By default, the feature is on. Disable it if your organization requires only exact matches on all keywords.

  • Maximum extracted articles per entity screening: specify the maximum number (from 1 to 30) of articles to fetch. By default, up to 20 articles are retrieved.

  • Search period: select a time frame to specifically search for information published within it.

  • File types to exclude from results: select the file types that you want to exclude from Google results:

    • HTML is included by default.
    • Non-HTML file types do not have the same metadata and tagging. Excluding them reduces the number of articles to review and false hits by 50% without increasing the risk of missing a true hit.

  • Enable partial name search?: select to dynamically substitute names if no results were found for their full variants.

  • Use dynamic location search?: select to dynamically broaden the search location for an entity if no results are found for the initial location setting.

  • Ignore articles with errors?: exclude those articles that failed to be downloaded.

  • Exclude articles where the searched entity was not found?: if enabled, articles where Evan failed to detect the entity’s name in the text are excluded.

  • Automatically escalate articles that are too small?: if the setting is enabled, Evan automatically escalates small articles for human review by default. A small article is one with less than 50 words.

Factiva​

  • Factiva Headlines API URL: select one of the options below as the Factiva API address.

  • Factiva Headlines API Key alias: specify the corresponding Secrets Vault alias for the Factiva system. Choose an existing alias or click Create Secrets Vault entry to set up one.

  • Article language: select the language of articles to search in. The English language is the default option.

  • Screening keywords: specify the keywords for the search or upload them as a CSV file. You can add a maximum of 28 words.

    The following keywords are added by default based on the article languages you select:

    • English:

      ACCUSE, ARREST, BRIBE, CONVICT, CORRUPT, COUNTERFEIT, CRIME, EMBEZZLEMENT, FRAUD, GUILT, ILLEGAL, INDICTMENT, INVESTIGATION, KICKBACK, MONEY LAUNDERING, NARCOTIC, PENALTY, SANCTION, SENTENCED, EVASION, TERRORIST, THEFT, TRAFFICKING, VIOLATION

    • Spanish:

      ACUSAR, ARRESTAR, SOBORNO, CORRUPTO, FALSIFICACIÓN, CRIMEN, MALVERSACIÓN, FRAUDE, CULPA, ILEGAL, ACUSACIÓN, INVESTIGACIÓN, CONTRAGOLPE, LAVADO DE DINERO, NARCÓTICO, MULTA, SANCIÓN, SENTENCIADO, EVASIÓN, TERRORISTA, ROBO, TRÁFICO, VIOLACIÓN

  • Maximum extracted articles per entity screening: specify the maximum number (from 1 to 30) of articles to fetch. By default, up to 20 articles are retrieved.

  • Search period: select a time frame to specifically search for information published within it.

LexisNexis​

  • LexisNexis L&P Media API URL: select the address of the LexisNexis API. By default, it is https://services-api.lexisnexis.com.

  • LexisNexis L&P Media authorization URL: specify the Authentication URL for the LexisNexis News. By default, it is https://auth-api.lexisnexis.com.

  • LexisNexis L&P Media API Key alias: specify the corresponding Secrets Vault alias for the LexisNexis News system. Choose an existing alias or click Create Secrets Vault entry to set up one.

  • Article language: select the language of the articles to search in. The English language is used by default.

  • Screening keywords: specify the keywords for the search or upload them as a CSV file. You can add a maximum of 28 words.

    The following keywords are added by default based on the article languages you select:

    • English:

      ACCUSE, ARREST, BRIBE, CONVICT, CORRUPT, COUNTERFEIT, CRIME, EMBEZZLEMENT, FRAUD, GUILT, ILLEGAL, INDICTMENT, INVESTIGATION, KICKBACK, MONEY LAUNDERING, NARCOTIC, PENALTY, SANCTION, SENTENCED, EVASION, TERRORIST, THEFT, TRAFFICKING, VIOLATION

    • Spanish:

      ACUSAR, ARRESTAR, SOBORNO, CORRUPTO, FALSIFICACIÓN, CRIMEN, MALVERSACIÓN, FRAUDE, CULPA, ILEGAL, ACUSACIÓN, INVESTIGACIÓN, CONTRAGOLPE, LAVADO DE DINERO, NARCÓTICO, MULTA, SANCIÓN, SENTENCIADO, EVASIÓN, TERRORISTA, ROBO, TRÁFICO, VIOLACIÓN

  • Maximum extracted articles per entity screening: specify the maximum number (from 1 to 30) of articles to fetch. By default, up to 20 articles are retrieved.

  • Search period: select a time frame to specifically search for information published within it.

World-Check One​

  • World-Check One API URL: select the address of the World-Check One API. The default one is https://api-worldcheck.refinitiv.com.

  • World-Check One groupID: specify the Group Id for the World-Check One system.

  • World-Check One API Key alias: specify the corresponding Secrets Vault alias for the World-Check One system. Choose an existing alias or click Create Secrets Vault entry to set up one.

  • Article language: select the language of the articles to search in. The English language is used by default.

  • Screening keywords: specify the keywords for the search or upload them as a CSV file. You can add a maximum of 28 words.

    The following keywords are added by default based on the article languages you select:

    • English:

      ACCUSE, ARREST, BRIBE, CONVICT, CORRUPT, COUNTERFEIT, CRIME, EMBEZZLEMENT, FRAUD, GUILT, ILLEGAL, INDICTMENT, INVESTIGATION, KICKBACK, MONEY LAUNDERING, NARCOTIC, PENALTY, SANCTION, SENTENCED, EVASION, TERRORIST, THEFT, TRAFFICKING, VIOLATION

    • Spanish:

      ACUSAR, ARRESTAR, SOBORNO, CORRUPTO, FALSIFICACIÓN, CRIMEN, MALVERSACIÓN, FRAUDE, CULPA, ILEGAL, ACUSACIÓN, INVESTIGACIÓN, CONTRAGOLPE, LAVADO DE DINERO, NARCÓTICO, MULTA, SANCIÓN, SENTENCIADO, EVASIÓN, TERRORISTA, ROBO, TRÁFICO, VIOLACIÓN

  • Maximum extracted articles per entity screening: specify the maximum number (from 1 to 30) of articles to fetch. By default, up to 20 articles are retrieved.

  • Search period: select a time frame to specifically search for information published within it.

info

For the World-Check One provider, keywords highlight important sections within each article returned by the search, but not for the API call. Configure the keywords for your search at the World-Check One's website.

Thomson Reuters CLEAR Adverse Media​

warning

Make sure that all provider-specific fields are properly configured in the Thomson Reuters Connector settings.

  • Use Scrape.do to download the articles that could not be retrieved: when enabled, Scrape.do will parse any website that your internal APIs failed to parse.

  • ScrapeDo Secret Vault alias: if you choose to utilize Scrape.do, specify the credentials for its licence. You can create a Secrets Vault entry on the go by clicking Create Secrets Vault entry.

  • Use browser rendering if a standard Scrape.do download attempt fails: when enabled, Scrape.do API will use different techniques to bypass the paywalls from some websites.

  • Article language: select the language of the articles to search in. The English language is used by default.

  • Maximum extracted articles per entity screening: specify the maximum number (from 1 to 30) of articles to fetch. By default, up to 20 articles are retrieved.

  • Search period: select a time frame to specifically search for information published within it.

  • File types to exclude from search results: select the file types that you want to exclude from the provider's results:

    • HTML is included by default.
    • Non-HTML file types do not have the same metadata and tagging. Excluding them reduces the number of articles to review and false hits by 50% without increasing the risk of missing a true hit.
warning

To start using Thomson Reuters Clear API, you need to install the connector. You also need to add all public IP addresses of agents to Thomson Reuters Whitelist (for that, contact the Thomson Reuters team).

Additionally, Thomson Reuters keystore should be installed to /opt/workfusion/ssl on the Master node. Once it is installed, create the tr.clear.api.keystore Secrets Vault entry, where the key is the path to the keystore file, and the value is the certificate password.

External Source​

When the option is selected, AMM doesn't search in a news provider. Instead, the AI Agent uses the article links provided in the input CSV data file.

To enable sourcing data from a CSV file, do as follows:

  1. Make sure your CSV file has the correct format. To do that, download a CSV file template by clicking the Template link. Files that do not comply with the format requirements are not ingested.

  2. On the configuration screen, specify the following general screening settings:

    • Select Use Scrape.do to download the articles that could not be retrieved if you want Scrape.do to parse any website that your internal APIs failed to parse. In case you enable the option, specify the credentials for the Scrape.do licence in the Scrape.do Secret Vault alias field. You can also create a Secrets Vault entry on the go by clicking the Create Secrets Vault entry button.

    • Select Use browser rendering if a standard Scrape.do download attempt fails if you want Scrape.do API to use different techniques to bypass the paywalls from some websites.

    • Set Do you want to ignore dead links? to Yes if you want Evan to exclude invalid links from the final result.

    • Set Do you want to ignore articles that redirect? to Yes if you want Evan to exclude the links that return 30X statuses from the final result.

  3. In the CSV file monitoring settings section, configure the following:

    • Input file bucket: specify the S3 bucket name where you need to upload the CSV file.
    • Input file location: specify the path to the directory where you need to upload the CSV file.
    • Monitoring frequency and Time Unit: configure the interval of monitoring for CSV files.
tip

Clicking the Template link allows you to download a CSV file template.

Proactive screening​

If you indicate that you want the entities to be screened Proactively using event-based monitoring, you are requested to choose a search provider.

For now, ongoing monitoring is available only with the Thomson Reuters provider.

warning

Make sure that all provider-specific fields are properly configured in the Thomson Reuters Connector settings.

  • Use Scrape.do to download the articles that could not be retrieved: when enabled, Scrape.do will parse any website that your internal APIs failed to parse.

  • ScrapeDo Secret Vault alias: if you choose to utilize Scrape.do, specify the credentials for its licence. You can create a Secrets Vault entry on the go by clicking Create Secrets Vault entry.

  • Use browser rendering if a standard Scrape.do download attempt fails: when enabled, Scrape.do API will use different techniques to bypass the paywalls from some websites.

  • Article language: select the language of the articles to search in. The English language is used by default.

  • Maximum extracted articles per entity screening: specify the maximum number (from 1 to 30) of articles to fetch. By default, up to 20 articles are retrieved.

  • File types to exclude from search results: select the file types that you want to exclude from the provider's results:

    • HTML is included by default.
    • Non-HTML file types do not have the same metadata and tagging. Excluding them reduces the number of articles to review and false hits by 50% without increasing the risk of missing a true hit.

To start using Thomson Reuters Clear API for ongoing monitoring, comply with the following requirements:

  1. Install the Thomson Reuters CLEAR API connectors as described in the guide.

  2. Add all public IP addresses of your Agents to Thomson Reuters Whitelist. For that, contact Thomson Reuters team.

  3. Install the Thomson Reuters keystore to /opt/workfusion/ssl on the master node. Once it is installed, create the tr.clear.api.keystore Secrets Vault entry, where key is the path to the keystore file and value is the certificate password.

Validation settings​

In the section, you can select the options to validate the following input data entities:

  • Country of residence or operating country
  • Country of citizenship or incorporation
  • Subdivision
  • City

All validations are enabled by default.

Investigation​

After setting the Input parameters, click Next to go to the following step of the wizard.

General settings​

  • Do you want the Digital Worker to identify and group duplicate content?: set to Yes for AMM to identify and group articles by the specified similarity threshold. By default, the threshold is set to 50%. However, you can configure it in the field below.

  • Do you want to use available meta data to adjudicate articles first?: applicable only for the External Source input. Set to Yes for AMM to use the metadata from the input file and process it with the NSS model before running the investigation. To start using it, you also need to configure signal_id from the Execute NSS step in the Adverse Media Monitoring File Ingestion BP.

  • Remove legal endings: select Yes to remove legal endings from the company entities. Entities with common names or small businesses (LLCs, S corps) can receive more tailored results when the option is set to No.

  • Preferred date format: select the date format to use for input and output data.

Ad-hoc investigation settings​

  • Fields to include in the ad-hoc investigation task: configure what fields should be visible on the ad-hoc search screen.

  • Number of investigation tasks to be created in Workspace: configure how many Submit Investigation Tasks you want to create when running the Ad hoc investigation BP. The recommended setting is one task per 2-3 analysts.

  • Always assign human-in-the-loop tasks to the person who initiates the investigation: if selected, all manual review tasks created by the user are automatically assigned to them.

Article classification settings​

  • Classification model for article processing: select the version of the model you want to use. The latest model is selected by default.

  • Do you want to use GenAI to help disposition articles? Specify if you want a Large Language Model (LLM) to back up the dispositioning of articles in case the selected AMM model fails to take a decision.

    As you select Yes, you are prompted to specify the following:

    1. Select an LLM provider. Available options include OpenAI, MistralAI, Google, and Anthropic.

    2. Choose the provider's LLM model and its version. Mind that you can be charged additionally for using the OpenAI models according to your pricing plan with the provider.

      When you choose the Other option in the model list, a free-text input field is shown for a custom model name to be typed in.

    3. Choose a screening approach. The available options are as follows:

      • Entity extraction and age disposition only: the LLM model helps to match the name and age of the screened entity. The AMM OOTB model age-matching functionality is not used.

      • Entity and crime extraction, age disposition: the LLM model helps to match the name and age of the screened entity. Additionally, it identifies the crime mentioned in articles and generates a decision comment. The AMM OOTB model age-matching and article disposition functionality is not used.

    4. To create a Secrets Vault entry, if you don't have one, click Create Secrets Vault entry and follow the instructions in the Set up secret entries in Secrets Vault guide.

  • Date of birth matching threshold: articles are marked as False Positive if the difference between the age of the screened entity and the age of the entity in the article is greater than the value configured here. The default setting is 2 years.

  • High-risk countries: select countries from the drop-down box or type them in. The configured high-risk countries are highlighted in articles returned from each investigation.

Advanced article classification settings​

In the section, configure custom investigation statuses and comments for various ML decisions.

Human in the Loop​

Configure whether and how you want to send the search results to Workspace by selecting one of the following options:

  • Send in all cases: the AI Agent creates Manual Review steps for every search run.

  • Do not send when there are no new articles to review: the AI Agent skips the Manual Review step when all retrieved articles are evaluated as False Positive or have been previously reviewed1 with the False Positive status.

  • Do not send when all new articles are false positive: the AI Agent skips the Manual Review step when all retrieved articles are evaluated as False Positive or have been previously reviewed1 with any status.

  • Do not send in all cases: the AI Agent skips the Manual Review step in all cases, sticking to model decisions.

Depending on the selected option, configure the settings below:

  • Decision reapplication matching conditions: set the rules for applying decision reapplication.

    • Required matching decisions: how many times an article with the same status needs to be reviewed for a decision to be re-applied.

    • Required distinct users: how many unique users need to review an article with the same status before a decision is reapplied.

  • Enable Auto QC?: if enabled, the specified percentage of false positive articles are flagged for manual review for quality control purposes. Set the percentage in the Percentage of articles to sample for Auto QC field.

  • Require users to disposition all articles?: set to Yes if you want users to disposition all articles prior to closing an investigation in Workspace.

  • Restricts the analyst from closing an investigation with True Positive status on the initial review? Specify whether you want to allow users to submit an investigation with the True positive status when it's opened the first time. When the option is set to Yes, one more review is required to close the task with the True Positive status.

  • Automatically route users to the next task after closing the investigation?: choose whether you want users to be routed to the next task in the queue. If disabled, users are always taken back to the main queue list after closing or saving an assignment.

  • Generate report if a manual assignment expires: if the parameter is set to Yes, when a manual review assignment in Workspace expires, it is considered submitted. The transaction is processed as usual, and a report is generated.

  • Shorthand list of predefined reasons: allows you to specify additional shorthand reasons that can be used by analysts during the manual review.

  • Use webhook to enable notification about alerts sent to Workspace for manual review: a webhook callback is sent every time when a manual review task is created.

    • URL for alerts sent to manual review: URL triggered with webhook callbacks. For the webhook payload structure, see the API documentation.

    • Encrypt the webhook payload: select to encrypt the webhook payload and, in the Encryption key alias field, specify the name of the alias in Secrets Vault containing the encryption key. If you do not have one, click Create Secrets Vault entry and set one up in accordance with the guide.

Output​

In the last step, specify the output parameters:

  • Final report and manual review task language: select the language of the final report and Manual Task.

  • Report preferences

    • Generate combined report: select to generate a combined report. The option is not available for requests through REST API.

    • Generate batch report: select to generate a batch report. The option is not available for requests through REST API.

  • Report format: select the format of the report for screening requests. Available options are HTML or PDF.

  • Remove article details for the report?: if set to Yes, AMM generates only the short version of the report without the full article text.

  • Send quality control report to: once a batch of records is processed and a quality control report is generated, the latter is sent to the email specified in the field. Note that the quality report is not generated when screening starts with REST API.

  • Use webhook to enable notification when an alert is closed: if selected, a webhook callback is sent every time when the investigation completes.

    • URL for closed alerts: specify the URL to be triggered with a webhook callback. For the webhook payload structure, see the API documentation.
    • Encrypt the webhook payload: select if you want the webhook payload to be encrypted and, in the Encryption key alias field, specify the name of the alias in Secrets Vault containing the encryption key. If you do not have one, click Create Secrets Vault entry and set one up in accordance with the guide.

Review configuration​

Once you complete the required fields, review the configuration. You can return to any step to change previous settings before finalizing. If everything is correct, click Finish. You are now ready to use AMM to run an investigation.

Advanced settings​

Configure Data Purge​

The Adverse Media Monitoring Data Purge Business Process is an additional AMM component. It allows cleaning up old data in the environment.

Configure Data Purge settings​

To configure Data Purge settings, do the following:

  1. Log in to Control Tower.

  2. Click the Advanced tab and select Data Stores.

  3. Select uc_amm_configuration_v1 and set the following parameters:

    NameValue typeExampleDescription
    dataPurge.storagePeriodInDaysInteger30Specify how many days after the completion of a transaction its data should be stored.
    dataPurge.historyStoragePeriodInDaysInteger30Specify how many after the completion of a transaction its history data should be stored (used in decision reapplication).
    dataPurge.userActivityStoragePeriodInDaysInteger30Specify how many days after the completion of a transaction user activity data should be stored.
    dataPurge.deleteReportstrue/falsefalseSet to true to delete generated reports.
    dataPurge.deleteAnalyticsDatatrue/falsefalseSet to true to delete analytics data.
    dataPurge.deleteArticleAndInvestigationHistorytrue/falsefalseSet to true to delete the historical data for previous investigations (used in decision reapplication).
    dataPurge.deleteUserActivitytrue/falsefalseSet to true to delete the user activity data.

Configure Data Purge scheduling​

You can run the Data Purge BP manually or on a schedule. To configure the schedule, do the following:

  1. Log in to Control Tower.

  2. Go to the Advanced tab and select Schedules.

  3. Click Create.

  4. In the Create Schedule window, set the following parameters:

    • In Process Definition, select Adverse Media Monitoring Data Purge vX.X.X | AMM | X.X.X.
    • In Input Data, select Empty.
    • Specify Schedule Period to run Data Purge only for some period. Otherwise, leave it empty.
    • In Schedule Name, set the operation's name, for example, Adverse Media Monitoring Data Purge.
    • In Schedule Frequency, specify days and times when Data Purge must be started. It is recommended to set the time when the environment is least loaded, for example, nightly hours on weekends.

  5. Click Save.

After that, the purge operation runs automatically on a specified day and time.

To learn more about data purging in Work.AI, see the following guides:

Configure REST API endpoints​

To configure REST endpoints for Adverse Media Monitoring, perform the following steps:

  1. In Control Tower, open the core BP definition Adverse Media Monitoring vX.X.X. On the Data tab, select Streaming Records from External Sources. Here, you can also specify a custom signal id if needed:

  2. On the Run tab, click Run This Process.

  3. After the BP starts, return to the Run tab and click Show API to find all available generated endpoints:

For Adverse Media Monitoring, only asynchronous invocation is supported, in particular the following endpoints:

  • /start-record-raw/ to start a BP

  • /check-record-status/ to check the status of a running transaction

  • /get-record-result/ to get the result data of a finished transaction

For detailed information on invoking transactions and getting access to a token, see Running AI Agents via REST API.

Sample JSON request
{
  search_request: String (required),
  entity_type: String (COMPANY/INDIVIDUAL),
  year_of_birth: Integer,
  citizenship_country: String (2 letter ISO Country code),
  residence_country: String (2 letter ISO Country code),
  subdivision: String (ISO 3166-2 code of the subdivision),
  city: String (Full City name. Used only by Thomson Reuters provider),
  search_period: Integer (search period in days),
  entity_id: String (Used for decision reapplication),
  batch_id: String (Used to group search entities for combined reports generation)
}
Sample JSON response
{
    "transactionUUID" : String,
    "runUUID" : String,
    "variationUUID" : String,
    "startTime" : UTC-date,
    "endTime" : UTC-date,
    "searchRequest" : String,
    "investigationStatus" : String (FALSE_POSITIVE/TRUE_POSITIVE/NEEDS_INVESTIGATION/NO_RESULTS_FOUND),
    "newsProvider" : String,
    "manualTaskExecuted" : boolean,
    "reviewerUUID" : String,
    "reviewerName" : String,
    "reviewComment" : String,
    "reportLink" : String,
    "articles" : [
        {
            "articleUUID" : String,
            "tile" : String,
            "summary" : String,
            "investigationStatus" : String (FALSE_POSITIVE/TRUE_POSITIVE/NEEDS_INVESTIGATION),
            "adjudicationReason" : String,
            "publishingDate" : UTC-date,
            "author" : String,
            "language" : String,
            "wordCount" : int,
            "source" : String,
            "articleLink" : String,
            "originalArticleLink" : String,
            "score" : Decimal,
            "isReviewed" : boolean,
            "reviewerUUID" : String,
            "reviewerName" : String,
            "reviewComment" : String,
            "errorCode" : String
        },
        ...
    ]
}

To configure the ad-hoc search settings, follow the steps below:

  1. Log in to Control Tower.

  2. On the main menu, navigate to Advanced > Data Stores.

  3. In the Data Store list, select uc_amm_configuration_v1 and enter the values for the following parameter:

NameValue typeExampleNotes
adHoc.investigationBatchMaxSizeInteger100Defines how many entity names can be in one investigation batch.

Verify settings​

To check that the Business Process is configured correctly, try running an investigation.

  1. Articles are marked as reviewed if the status or comment were updated manually.↩
Last updated on