Difference between revisions of "SsGet"
Dan Eardley (talk | contribs) |
Dan Eardley (talk | contribs) |
||
| Line 1: | Line 1: | ||
| − | = | + | =General Overview= |
The ''ssGet'' variable is used to extract information from a number of databases. These include: | The ''ssGet'' variable is used to extract information from a number of databases. These include: | ||
| Line 11: | Line 11: | ||
==Configuration - Office of Foreign Assets Control (OFAC)== | ==Configuration - Office of Foreign Assets Control (OFAC)== | ||
| − | {{ProfessionalServices}} | + | {{Template:ProfessionalServices}} |
On-request checks can be made against the OFAC's online database within SmartSimple. For example, on an organization [[profile]], a [[Web_Page_View_Field]] can be configured that exposes the following check results: | On-request checks can be made against the OFAC's online database within SmartSimple. For example, on an organization [[profile]], a [[Web_Page_View_Field]] can be configured that exposes the following check results: | ||
| Line 74: | Line 74: | ||
| − | |||
| + | ==Configuration - Watch List Scanning== | ||
| + | SmartSimple, in partnership with our Watch List providers (CSI Web or Lexis Nexis) can provide access to additional third party services lists beyond the OFAC list. When utilizing these services, a contractual agreement must be established with one of the two integrated providers. The account credentials you receive will be utilized within your instance of SmartSimple to establish the integration. | ||
| + | In Global Settings, under the Integrations tab, you will locate the Watch List Settings. | ||
| + | |||
| + | The Watch List Settings provide the ability to enter your billing id and password for the third party service you are utilizing. | ||
| + | |||
| + | <br />When utilizing CSI Web, there are settings to define the watch list(s) you wish to search against, and the scan threshold, which will dictate only being shown results that match or exceed the percentage match threshold. | ||
| + | |||
| + | The list of supported third party services with CSI Web includes: | ||
| + | |||
| + | * U.S. Bureau Of Industry and Security | ||
| + | * Department of State - Bureau of International Security & *Nonproliferation list | ||
| + | * Department of State - Defense Trade Controls Debarred Parties list | ||
| + | * International Criminal Police Organization (INTERPOL) | ||
| + | * Politically Exposed Persons, CIA Foreign Officials | ||
| + | * Office of Inspector General | ||
| + | * Excluded Parties List System provided by the General Services Administration (GSA) | ||
| + | * Financial Crimes Enforcement Network | ||
| + | * FinCEN Money Services Business | ||
| + | * World Bank Ineligible Firms | ||
| + | * Terrorist Exclusion List | ||
| + | * FBI Most Wanted Fugitives | ||
| + | |||
| + | |||
| + | When utilizing Lexis Nexis, the settings for which watch list services will be included in each scan, along with threshold settings, will be managed within your Lexis Nexis account and not within the SmartSimple instance. | ||
==Configuration - Returning information from U.S. Census database== | ==Configuration - Returning information from U.S. Census database== | ||
Revision as of 15:54, 16 October 2019
Contents
General Overview
The ssGet variable is used to extract information from a number of databases. These include:
- The OFAC (Office of Foreign Assets Control) database
- Watch List Integration third party providers
- U.S. census data
- Janus, SmartSimple’s Machine Learning tool.
The syntax for the ssGet variable varies by the database from which information is being returned.
Configuration - Office of Foreign Assets Control (OFAC)
On-request checks can be made against the OFAC's online database within SmartSimple. For example, on an organization profile, a Web_Page_View_Field can be configured that exposes the following check results:
In the above illustration, the OFAC check has returned one 100% match result on the company name, and no results on the attached contacts. The syntax for configuring the OFAC check is as follows:
- @ssGet(OFAC,entity;;firstname;;lastname;;search options;;roleslist;;meta template;;line template)@
Settings Explained - Office of Foreign Assets Control (OFAC)
| Setting | Description |
| Entity | accepts "people", "company" or "all" |
| firstname | an individual's first name or company name |
| lastname | an individual's last name (will be ignored if entity is "company" or "all") |
| search options | accepts "1", "2" or "3"
|
| rolelist | applies if "search options" is set to "2" or "3". Should be in format of comma-delimited role ids or role names (but not ids mixed with names). |
| meta template | Template of how "header" of results will be returned. Default template will be used if empty.
variables that can be used include:
Example: "Search type : [[entity]] , Search for : [[name]], Records returned : [[recordcount]], Date :[[now]]" |
| line template | Template of how "body" of results will be returned. Default template will be used if empty.
variables that can be used include:
|
In order to run an ad hoc OFAC check on a particular organization record, a Web_Page_View_Field must be created within the Organization custom fields. The content of the Web_Page_View_Field may be configured simiarly to the example shown below:
When using a Web_Page_View_Field, you have the option to 'Enable Save to Server' within the field settings. This will allow you to define an upload field on the organization profile where the stored PDF copy of the OFAC results will be saved when triggered.
Configuration - Watch List Scanning
SmartSimple, in partnership with our Watch List providers (CSI Web or Lexis Nexis) can provide access to additional third party services lists beyond the OFAC list. When utilizing these services, a contractual agreement must be established with one of the two integrated providers. The account credentials you receive will be utilized within your instance of SmartSimple to establish the integration.
In Global Settings, under the Integrations tab, you will locate the Watch List Settings.
The Watch List Settings provide the ability to enter your billing id and password for the third party service you are utilizing.
When utilizing CSI Web, there are settings to define the watch list(s) you wish to search against, and the scan threshold, which will dictate only being shown results that match or exceed the percentage match threshold.
The list of supported third party services with CSI Web includes:
- U.S. Bureau Of Industry and Security
- Department of State - Bureau of International Security & *Nonproliferation list
- Department of State - Defense Trade Controls Debarred Parties list
- International Criminal Police Organization (INTERPOL)
- Politically Exposed Persons, CIA Foreign Officials
- Office of Inspector General
- Excluded Parties List System provided by the General Services Administration (GSA)
- Financial Crimes Enforcement Network
- FinCEN Money Services Business
- World Bank Ineligible Firms
- Terrorist Exclusion List
- FBI Most Wanted Fugitives
When utilizing Lexis Nexis, the settings for which watch list services will be included in each scan, along with threshold settings, will be managed within your Lexis Nexis account and not within the SmartSimple instance.
Configuration - Returning information from U.S. Census database
@ssGet(FFD,FIPS;;@address@ @city@ @state@)@
@ssGet(FFD,Profile;;year;;Address or FIPS code;;level;;[[template]])@
(See Census Integration for detailed description of syntax.)
(See List of census templates for links to full list of values for [[template]])
Configuration - Returning information from Janus
@ssGet(JANUS,modelname)@
