Skip to main content
Version: 3.3.1

Install and configure

This page provides the instructions for the AMM AI Agent's installation to the v.10.2.5+ instance.

Requirements

Hardware

The AMM skill runs on the standard Intelligent Automation Cloud hardware configuration, as documented in System Requirements.

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

Software

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

  • You have installed IA Cloud Enterprise v.10.2.5+ and have Control Tower and Analytics components enabled. For IA Cloud 10.1.6+, ODF 2 is installed automatically along with the system.
  • You have the bundle with 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.

To check that ODF is installed:

  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. The 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-10.1.0.7.zip to your local workstation.

Performance

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

Below is a sample of the volumes that can be expected when using the provided version and configuration. The system shows stable performance and resource consumption during the test without unexpected spikes or critical errors and warnings in logs.

The Search provider used is Google API; note that throughputs may vary slightly based on the provider.

Configuration:

Skill versionEnvironment topologyTested IA Cloud versionNumber of RPA BotsNumber of OCR WorkersAutoML Worker configurationControl Tower Worker configuration
3.1.03 / 6 / 20 Agents10.2.7571 CPU / 4 GB memory0.4 CPU / 2 GB memory

Results:

Number of AgentsNumber of entitiesDurationNumber of AMM WorkersHits/hour
38401 hr 30 min811,200
684055 min1816,800
2084024 min6042,000
2084034 min6059,000

Here, 1 Entity = 20 articles.

Install Skill

See the Install AI Agents guide.

Configure Skill

Once Adverse Media Monitoring is installed, configure the skill before running it for the first time.

You can configure multiple variations, or sets of parameters, for AMM. For example, a different media provider or a set of keywords per variation. For more information, see the 10.2.5 release notes.

Credentials

Before setting the news providers, ensure you have obtained the corresponding license with credentials.

The following search providers are supported:

  • Google API
  • Dow Jones Factiva Headlines
  • LexisNexis L&P Media
  • World-Check One

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 are using Google API, provide the credentials first. To do that on a GCP-hosted environment, see the instruction under the expand:

Provide new credentials for Google API
The Google API used for Adverse Media Monitoring is the Custom Search JSON API.

You must provide credentials from WorkFusion’s Developer account owned by the Cloud Ops team.

GCP requires unique credentials to be used in 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 new credentials, do the following:

  1. Log into 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. Select “Create Credentials”.

  5. Enter a Name for the API Key, then in the Application restrictions group, select HTTP referrers, and click Save.

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

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

    You must add the key value to the Secrets Vault's key field. The Value field is static.

You must first set up the above credentials in the Secrets Vault to use other providers besides Google API. For the step-by-step instructions, see this guide.

Configure the smtp credentials

Adverse Media Monitoring emails analysts when results are ready, and the final report is available. To enable notification, configure the SMTP credentials. You must provide your own SMTP to ensure the respective security protocols are followed.

Update configuration in Data Store

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

  1. Log in to the Control Tower.
  2. In the main menu, navigate to Advanced and select Data Stores.
  3. Select the uc_amm_configuration_v1 configuration 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 a 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 alias in the Secrets Vault, which contains the access credentials to the SMTP server
Set up entry for SMTP credentials in Secrets Vault
info

Only if smtp.authEnabled is set to "true".

See Set up secret entries in Secrets Vault.

The key is the email address, and the value is the password.

tip

Use a descriptive name such as amm_smtp_credentials.

Configure Proxy

To configure a proxy, do the following:

  1. Log in to the Control Tower.

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

  3. Select the uc_amm_configuration_v1 configuration and specify the following:

    NameExampleNotes
    proxy.hostproxy.customerdomain.comUse your proxy host
    proxy.port9473Use you 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, in Secrets Vault, set up proxy credentials.

    See Set up secret entries in Secrets Vault. The key is the username address, and the value is the password.

Input

To set up your installed AI Digital Worker, do the following:

  1. In the Control Tower menu, in the Digital Workers section, find your newly installed AMM skill, and click the Prepare button.

    The Prepare your digital worker window containing a configuration form appears.

  2. In the window, on the Input step, select a news provider for searching for news about the entity or individual. "Google API" is set by default.

    The required configurations may differ based on the selected news provider.

The Adverse Media Monitoring skill supports news retrieval from the following news providers:

  • Google API
  • Dow Jones Factiva Headlines
  • LexisNexis L&P News v1
  • World-Check One

The AMM skill can return results from up to four providers at a time. When selecting several providers, each will appear in a separate, collapsible section. Review each section carefully to ensure all required parameters are configured correctly. Available parameters may vary by provider.

See the following sections for a detailed description of each provider setting.

Google API

  • Google API Credentials Location. Specify the corresponding Secret Vault alias for the Google API system.

  • Article Language. Select the language of articles to search in. 'Any' language is used by default. You can also choose Keyword Language and its following options:

    • Shared creates a single input field for keywords.
    • Defined by keyword language
  • Number of articles to extract. Specify the maximum number of reports to fetch from 1 to 20. By default, up to 20 articles are retrieved.

  • Search Time period. Select an option to find information published during a specific time frame. To specify the starting and the ending date for the articles' search, select Custom Range.

  • Dynamic Location Search. Select to dynamically broaden the search location for an entity if no results were found.

  • Keywords. Specify keywords to be used for the search. 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 Keyword Thesaurus. Activate to look not only for exact keywords but also for their synonyms. By default, the feature is turned on. Disable it if your organization requires only exact matches on all keywords.

  • High-risk countries. Select countries from the dropdown or enter their names in the search field. The high-risk countries configured here are highlighted in articles returned from each investigation.

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

Factiva

  • Factiva API URL. Select the address of the Factiva API. Available options:

  • Factiva Credentials Location. Specify the corresponding Secrets Vault alias for the Factiva system.

  • Article Language. Select the language of articles to search in. The 'English' language is used by default.

  • Number of articles to extract. Specify the maximum number of reports to fetch from 1 to 20. By default, up to 20 articles are retrieved.

  • Search Time period. Select an option to find information published during a specific time frame.

  • Keywords. Specify keywords to be used for the search. 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
  • High-risk countries. Select countries from the dropdown or enter their names in the search field. The high-risk countries configured here are highlighted in articles returned from each investigation.

LexisNexis

  • LexisNexis API URL. Select the address of the LexisNexis API. By default, https://services-api.lexisnexis.com.
  • LexisNexis Authentication URL. Specify the Authentication URL for the LexisNexis News. By default, https://auth-api.lexisnexis.com.
  • LexisNexis Credentials Location. Specify the corresponding Secret Vault alias for the LexisNexis News system.
  • Article Language. Select the language of articles to search in. The 'English' language is used by default.
  • Number of articles to extract. Specify the maximum number of reports to fetch from 1 to 20. By default, up to 20 articles are retrieved.
  • Search Time period. Select an option to find information published during a specific time frame.
  • High-risk countries. Select countries from the dropdown or enter their names in the search field. The high-risk countries configured here are highlighted in articles returned from each investigation.
  • Keywords. Specify keywords to be used for the search. You can add a maximum of 28 words.

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 Group. Specify the Group Id for the World-Check One system.
  • World-Check One Credentials Location. Specify the corresponding Secret Vault alias for the World-Check One system.
  • Article Language. Select the language of articles to search in. The 'English' language is used by default.
  • Number of articles to extract. Specify the maximum number of reports to fetch from 1 to 20. By default, up to 20 articles are retrieved.
  • Search Time period. Select an option to find information published during a specific time frame.
  • High-risk countries. Select countries from the dropdown or enter their names in the search field. The high-risk countries configured here are highlighted in articles returned from each investigation.
info

For the World-Check One provider, the keywords highlight important sections within each article returned by the search, but not for the API call. You must configure keywords to be used in a search at the World-Check One's website.

Investigation

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

  • ML Model Version. Select the model version to use. The latest model is selected by default.

  • Identify Duplicate Articles. Select Yes to identify and group articles by the configurable similarity threshold. By default, the value is set to 50%.

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

  • Human-in-the-Loop. Select Yes to enable the Manual Review Step (aka Human in the Loop). If the option is on, configure the additional options:

    • Frequency of use: Specify how frequently a Manual Task is created when at least one result per entity is found.
    • Require users to disposition all articles. Select Yes if users are required to disposition all articles before closing an investigation in Workspace.
    • Automatically route users to the next task. Select Yes to direct users to the next task in the queue. If the option is disabled, the users are always returned to the main queue list after closing or saving an assignment.
  • Number of submit investigation tasks. When running the Launcher Business Process, specify how many "Submit Investigation Tasks" you want to create. One task is suggested for two or three analysts.

Output

In the last step, specify the Output parameters:

  • Interface Language. Select the language of the final report and Manual Tasks.
  • Report Format. Select the report file format for generating a screening request: HTML or PDF.

Review

Once you complete the required fields, review the configuration. You can return to any step to change previous settings before finalizing. If everything looks correct, click Finish. You are now ready to use the Adverse Media Monitoring skill.

Advanced settings

Configure Data Purge

The Data Purge Business Process is an additional part of Adverse Media Monitoring AI Digital Worker that allows for cleaning up old data on 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.storagePeriodInDaysInteger30How many days should pass after the completion of the transaction to delete the data
    dataPurge.deleteReportstrue/falsefalseSet to "true" to delete generated reports
    dataPurge.deleteAnalyticsDatatrue/falsefalseSet to "true" to delete analytics 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. On the Create Schedule window, select the following parameters:

    • In Task or 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 clearing, see the following sections on Purge in the Enterprise Edition documentation:

Configure REST API Endpoints

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

  1. In Control Tower, open the main BP definition Adverse Media Monitoring vX.X.X, and on the Data tab, select Streaming Records from External Sources. Here, also specify a custom signal id:

  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 detailed information on invoking transactions and getting access to a token, see Running Skills via REST API.

Verify settings

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