Difference between revisions of "SsGet"

From SmartWiki
Jump to: navigation, search
 
(20 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
__NOTOC__
+
=General Overview=
−
The ''ssGet'' variable is used to extract information from databases, including the [[OFAC, IRS, CRA Checks|OFAC (Office of Foreign Assets Control) database]], U.S. [[Census Integration|census data]] and [[:Category:Janus|Janus]], SmartSimple’s Machine Learning tool.
+
The ''ssGet'' variable is used to extract information from a number of databases.  These include:
 +
 
 +
* The [[OFAC, IRS, CRA Checks|OFAC (Office of Foreign Assets Control) database]]
 +
* Watch List Integration third party providers
 +
* U.S. [[Census Integration|census data]]
 +
 
  
 
The syntax for the ''ssGet'' variable varies by the database from which information is being returned.
 
The syntax for the ''ssGet'' variable varies by the database from which information is being returned.
  
−
==Returning information from the Office of Foreign Assets Control (OFAC)==
+
==Configuration - Office of Foreign Assets Control (OFAC)==
−
{{Billable}}
+
{{Template:ProfessionalServices}}
  
−
On-request checks can be made against the OFAC's online database within SmartSimple. For example, on an organization [[profile]], a button can be configured that exposes the following check results: <br />
+
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:
−
[[Image:RunOFACCheck2.png|link=|600px]]<br />
+
 
 +
: [[Image:RunOFACCheck2.png|link=|600px]]
 
In the above illustration, the OFAC check has returned one 100% match result on the company name, and no results on the attached contacts.
 
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:
 
The syntax for configuring the OFAC check is as follows:
  
 
: <span style="font-size: medium;">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</span>
 
: <span style="font-size: medium;">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</span>
−
The arguments are as follows:
+
===Settings Explained - Office of Foreign Assets Control (OFAC)===
 +
{| class="contenttable" style="height: 170px;" border=".5" width="1208"
 +
|-
 +
||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"
 +
* 1 - search current object only (when "entity" is set to "people" or "company")
 +
* 2 - search people underneath (when "entity" is set to "company" only)
 +
* 3 - search current object and people underneath (when "entity" is set to "company" only)
 +
 
 +
|-
 +
||rolelist
 +
||applies if "search options" is set to "2" or "3". Should be in format of comma-delimited [[roleid|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:
 +
* ''<nowiki>[[entity]]</nowiki>'' - search type
 +
* ''<nowiki>[[name]]</nowiki>'' - name of search result
 +
* ''<nowiki>[[recordcount]]</nowiki>'' - number of records returned by OFAC search
 +
* ''<nowiki>[[now]]</nowiki>'' - Current date
 +
''<nowiki>Example: "Search type : [[entity]] , Search for : [[name]], Records returned : [[recordcount]], Date :[[now]]"</nowiki>''
 +
 
 +
|-
 +
||line template
 +
||Template of how "body" of results will be returned. Default template will be used if empty.
 +
variables that can be used include:
 +
* ''<nowiki>[[index]]</nowiki>'' - index number
 +
* ''<nowiki>[[id]]</nowiki>'' - OFAC ID for result
 +
* ''<nowiki>[[name]]</nowiki>'' - OFAC name for result
 +
* ''<nowiki>[[type]]</nowiki>'' - OFAC type for result
 +
* ''<nowiki>[[alias]]</nowiki>'' - other aliases used
 +
* ''<nowiki>[[details]]</nowiki>'' - returns OFAC designation for entity returned, including date updated in OFAC database
 +
* ''<nowiki>[[score]]</nowiki>'' - percentage score of result match (for example, in the above example, the "company name" ''Boko Haram'' returned a 100% match. An organization with the name ''Bozo Haram'' will return an 88.9% match with ''Boko Haram''.
 +
 
 +
|}
 +
 
 +
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:
 +
 
 +
: [[Image:OFAC WPV.png|link=|800px]]
 +
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.
 +
 
 +
 
  
−
* ''entity'': accepts "people", "company" or "all"
+
==Configuration - Watch List Scanning==
−
* ''firstname'': an individual's first name or company name
+
SmartSimple, in partnership with our Watch List providers (CSI Web or Lexis Nexis Bridger) 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.
−
* ''lastname'': an individual's last name (will be ignored if entity is "company" or "all")
 
−
* ''search options'': accepts "1", "2" or "3"
 
−
** 1 - search current object only (when "entity" is set to "people" or "company")
 
−
** 2 - search people underneath (when "entity" is set to "company" only)
 
−
** 3 - search current object and people underneath (when "entity" is set to "company" only)
 
−
* ''roleslist'': applies if "search options" is set to "2" or "3". Should be in format of comma-delimited [[roleid|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:
+
In Global Settings, under the Integrations tab, you will locate the Watch List Settings.
−
:* ''<nowiki>[[entity]]</nowiki>'' - search type
+
 
−
:* ''<nowiki>[[name]]</nowiki>'' - name of search result
+
The Watch List Settings provide the ability to enter your billing id and password for the third party service you are utilizing. 
−
:* ''<nowiki>[[recordcount]]</nowiki>'' - number of records returned by OFAC search
+
 
−
:* ''<nowiki>[[now]]</nowiki>'' - Current date
+
<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.
−
''<nowiki>Example: "Search type : [[entity]] , Search for : [[name]], Records returned : [[recordcount]], Date :[[now]]"</nowiki>''
 
−
:* ''line template'': Template of how "body" of results will be returned. Default template will be used if empty
 
−
:: variables that can be used include:
 
−
::* ''<nowiki>[[index]]</nowiki>'' - index number
 
−
::* ''<nowiki>[[id]]</nowiki>'' - OFAC ID for result
 
−
::* ''<nowiki>[[name]]</nowiki>'' - OFAC name for result
 
−
::* ''<nowiki>[[type]]</nowiki>'' - OFAC type for result
 
−
::* ''<nowiki>[[alias]]</nowiki>'' - other aliases used
 
−
::* ''<nowiki>[[details]]</nowiki>'' - returns OFAC designation for entity returned, including date updated in OFAC database
 
−
::* ''<nowiki>[[score]]</nowiki>'' - percentage score of result match (for example, in the above example, the "company name" ''Boko Haram'' returned a 100% match. An organization with the name ''Bozo Haram'' will return an 88.9% match with ''Boko Haram''.
 
−
''<nowiki>Example:[[index]][[id]][[name]][[type]][[details]][[score]]</nowiki>''
 
  
−
:
+
The list of supported third party services with CSI Web includes: 
−
The following is an example of the configuration of the above display:
 
  
−
:: [[Image:OFACCheckWPVConfig.png|link=|600px]]
+
* U.S. Bureau Of Industry and Security
−
:: '''''Text version here:'''''
+
* Department of State - Bureau of International Security & *Nonproliferation list
−
:
+
* Department of State - Defense Trade Controls Debarred Parties list
−
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;"><!--filename="OFAC Check Results @name@ @date(currentdate)@"-->
+
* International Criminal Police Organization (INTERPOL)
−
<span style="text-decoration: underline;">OFACS CHECK RESULTS</span></pre><div style="pd4ml-display: none; border: 2px #009900 solid; background-color: #ffff66; padding: 10px; font-family: arial;">Save these results by clicking the "Save to Server as PDF" button above"</div>
+
* Politically Exposed Persons, CIA Foreign Officials
−
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;"><br />
+
* Office of Inspector General
−
@ssGet(OFAC,company;;@name@;;;;3;;Top 5 Staff,Board Officer;;<strong>[[entity]] Search:</strong> [[name]]<br /><strong>Matches Found:</strong> [[recordcount]]<br />;;Result #[[index]]</pre>
+
* Excluded Parties List System provided by the General Services Administration (GSA)
−
:* ID: [[id]]
+
* Financial Crimes Enforcement Network
−
:* Name: [[name]]
+
* FinCEN Money Services Business
−
:* Type: [[type]]
+
* World Bank Ineligible Firms
−
:* Details: [[details]]
+
* Terrorist Exclusion List
−
:* Score: [[score]]
+
* FBI Most Wanted Fugitives
−
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;">)@
 
−
<br />
 
−
<br />
 
−
<br />
 
−
Date/time check performed: <!--@sscalculation(DATE_FORMAT("@datetime(currentdate)@","%m/%d/%Y % %h:%i%p"))--> E.S.T.<br />
 
−
Performed by: @me.fullname@<br />
 
−
<br />
 
−
</pre>
 
  
−
==Returning information from Watchlist==
 
−
{{Billable}}
 
  
−
The syntax for configuring the Watch list check is as follows:
+
When utilizing Lexis Nexis Bridger, 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.
  
−
:: <span style="font-size: medium;">'''@ssGet(WatchList,entity;;firstname;;lastname;;search options;;roleslist;;meta template;;line template)@'''</span>
+
===Returning information from Watch List===
−
:
+
The syntax for configuring the Watch List check is as follows:
−
SmartSimple, in partnership with our Watch List provider (CSI Web) can provide access to a more 3rd party services lists than simply the OFAC list, although the client must pay for the service. The list of supported 3rd party services includes . . .
 
  
−
:* U.S. Bureau Of Industry and Security
+
:: <span style="font-size: medium;">'''@ssGet(ServiceName,entity;;firstname;;lastname;;search options;;roleslist;;meta template;;line template<span style="color: #ff0000;">;;''additional search attribute''</span>)@'''</span>
−
:* Department of State - Bureau of International Security & *Nonproliferation list
+
The ServiceName is dependent on which third party service you are utilizing:
−
:* 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
 
−
To check values stored as text, rather than actual Organization or Contact records then use $$ssGet(...)$$ instead of @ssGet(...)@. The following syntax example includes a list of Board Directors stored as XML data in a field named '''Board of Directors''':
 
  
−
<pre>@parent.client.xml.Board of Directors XML.boardDirectors.boardDirectorsAdd[#$ssGet(WatchList,company;;owner;;;;3;;Grant Seeker,Executive Director,Board Member;;
+
: CSI Web: WatchList
 +
: Lexis Nexis: LexisNexis
 +
The line template portion of the syntax allows you to include unique values and parameters in the scan criteria, such as date of birth or country. These values and the variables that correspond to them are unique to CSI Web and Lexis Nexis and will require reviewing the individual service provider's fields and available options.
 +
<pre style="padding-left: 30px;">@parent.client.xml.Board of Directors XML.boardDirectors.boardDirectorsAdd[#$ssGet(WatchList,company;;owner;;;;3;;Grant Seeker,Executive Director,Board Member;;
 
<strong>Board Member Search:</strong> ~Name.nodevalue~<br />Matches Found: [[recordcount]];;</pre>
 
<strong>Board Member Search:</strong> ~Name.nodevalue~<br />Matches Found: [[recordcount]];;</pre>
 
{| class="xmlSectionTable"
 
{| class="xmlSectionTable"
Line 110: Line 130:
 
| class="xmlCell"|[[score]]
 
| class="xmlCell"|[[score]]
 
|}
 
|}
−
<pre>;;unparsedname=~Name.nodevalue~)$#]@
+
<pre>;;unparsedname=~Name.nodevalue~)$#]@<br /><br />
 +
@ssGet(LexisNexis,people;;@firstname@;;@lastname@;;1;;;;<strong>Applicant Search:</strong> @firstname@ @lastname@<br />Matches Found: [[recordcount]];;</pre>
 +
{| class="xmlSectionTable"
 +
|-
 +
! class="xmlHead"|Result
 +
! class="xmlHead"|ID
 +
! class="xmlHead"|Name
 +
! class="xmlHead"|Type
 +
! class="xmlHead"|Alias
 +
! class="xmlHead"|Details
 +
! class="xmlHead"|Score
 +
||[[alias]]
 +
||[[details]]
 +
| class="xmlCell"|[[score]]
 +
|}
 +
<pre>;;)@[[index]][[id]][[name]][[type]]
 +
 
 
</pre>
 
</pre>
  
−
==Returning information from the online U.S. Census database==
+
==Configuration - U.S. Census Online Database==
 
@ssGet(FFD,FIPS;;@address@ @city@ @state@)@<br />
 
@ssGet(FFD,FIPS;;@address@ @city@ @state@)@<br />
 
@ssGet(FFD,Profile;;year;;Address or FIPS code;;level;;<nowiki>[[template]]</nowiki>)@<br />
 
@ssGet(FFD,Profile;;year;;Address or FIPS code;;level;;<nowiki>[[template]]</nowiki>)@<br />
 
'''(See [[Census_Integration#Returning_Census_Data|Census Integration]] for detailed description of syntax.)'''<br />'''(See [[List of census templates]] for links to full list of values for <nowiki>[[</nowiki>''template''<nowiki>]]</nowiki>)'''
 
'''(See [[Census_Integration#Returning_Census_Data|Census Integration]] for detailed description of syntax.)'''<br />'''(See [[List of census templates]] for links to full list of values for <nowiki>[[</nowiki>''template''<nowiki>]]</nowiki>)'''
−
 
−
==Returning information from [[:Category:Janus|Janus]]==
 
−
@ssGet(JANUS,modelname)@
 
  
 
==See Also==
 
==See Also==
 
:* [[Census Integration]]
 
:* [[Census Integration]]
 
:* [[OFAC, IRS, CRA Checks|OFAC, IRS and CRA Checks]]
 
:* [[OFAC, IRS, CRA Checks|OFAC, IRS and CRA Checks]]
−
:* [[:Category:Janus|Janus, SmartSimple’s Machine Learning tool]]
 
 
[[Category:Integration]][[Category:External Data Source]][[Category:Variables]]
 
[[Category:Integration]][[Category:External Data Source]][[Category:Variables]]
 
<!-- OFAC OFACS ofac ofacs OFACs -->
 
<!-- OFAC OFACS ofac ofacs OFACs -->

Latest revision as of 21:10, 11 September 2024

General Overview

The ssGet variable is used to extract information from a number of databases.  These include:


The syntax for the ssGet variable varies by the database from which information is being returned.

Configuration - Office of Foreign Assets Control (OFAC)

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:

RunOFACCheck2.png

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"
  • 1 - search current object only (when "entity" is set to "people" or "company")
  • 2 - search people underneath (when "entity" is set to "company" only)
  • 3 - search current object and people underneath (when "entity" is set to "company" only)
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:

  • [[entity]] - search type
  • [[name]] - name of search result
  • [[recordcount]] - number of records returned by OFAC search
  • [[now]] - Current date

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:

  • [[index]] - index number
  • [[id]] - OFAC ID for result
  • [[name]] - OFAC name for result
  • [[type]] - OFAC type for result
  • [[alias]] - other aliases used
  • [[details]] - returns OFAC designation for entity returned, including date updated in OFAC database
  • [[score]] - percentage score of result match (for example, in the above example, the "company name" Boko Haram returned a 100% match. An organization with the name Bozo Haram will return an 88.9% match with Boko Haram.

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:

OFAC WPV.png

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 Bridger) 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 Bridger, 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.

Returning information from Watch List

The syntax for configuring the Watch List check is as follows:

@ssGet(ServiceName,entity;;firstname;;lastname;;search options;;roleslist;;meta template;;line template;;additional search attribute)@

The ServiceName is dependent on which third party service you are utilizing:

CSI Web: WatchList
Lexis Nexis: LexisNexis

The line template portion of the syntax allows you to include unique values and parameters in the scan criteria, such as date of birth or country. These values and the variables that correspond to them are unique to CSI Web and Lexis Nexis and will require reviewing the individual service provider's fields and available options. 

@parent.client.xml.Board of Directors XML.boardDirectors.boardDirectorsAdd[#$ssGet(WatchList,company;;owner;;;;3;;Grant Seeker,Executive Director,Board Member;;
<strong>Board Member Search:</strong> ~Name.nodevalue~<br />Matches Found: [[recordcount]];;
Result ID Name Type Alias Details Score
index id name type alias details score 
;;unparsedname=~Name.nodevalue~)$#]@<br /><br />
@ssGet(LexisNexis,people;;@firstname@;;@lastname@;;1;;;;<strong>Applicant Search:</strong> @firstname@ @lastname@<br />Matches Found: [[recordcount]];;
Result ID Name Type Alias Details Score alias details score 
;;)@[[index]][[id]][[name]][[type]]

Configuration - U.S. Census Online 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]])

See Also

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=SsGet&oldid=43159’