__NOTOC__=General Overview=The ''ssGet'' variable is used to extract information from a number of databases, including the . 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]] and [[:Category:Janus|Janus]], SmartSimple’s Machine Learning tool.
The syntax for the ''ssGet'' variable varies by the database from which information is being returned.
==Returning information from the 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 button [[Web_Page_View_Field]] can be configured that exposes the following check results: <br /> : [[Image:RunOFACCheck2.png|600px|link=|600px]]<br />
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 : <span style="font-size: medium;">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</span>===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 configuring 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 is as followson 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. ==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.
:<font size="3">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</font>The Watch List Settings provide the ability to enter your billing id and password for the third party service you are utilizing.
The arguments <br />When utilizing CSI Web, there are as follows:* ''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 settings to "people" or "company"):*2 - search people underneath define the watch list(when "entity" is set to "company" only):*3 - search current object and people underneath (when "entity" is set to "company" onlys)* ''roleslist'': applies if "search options" is set you wish 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]] against, Search for : [[name]]and the scan threshold, Records returned : [[recordcount]], Date :[[now]]"</nowiki>''*''line template'': Template of how "body" of which will dictate only being shown 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>[[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 or exceed the above example, the "company name" ''Boko Haram'' returned a 100% match. An organization with the name ''Bozo Haram'' will return an 88.9% percentage match with ''Boko Haram''threshold. :''<nowiki>Example: <tr><td>[[index]]</td><td>[[id]]</td><td>[[name]]</td><td>[[type]]</td><td>[[details]]</td><td>[[score]]</td></tr></nowiki>'' The following is an example of the configuration of the above display:
The list of supported third party services with CSI Web includes:[[Image:OFACCheckWPVConfig.png|600px|link=]]
:'''''Text version here:'''''* U.S. Bureau Of Industry and Security<pre style="white* Department of State -space: preBureau of International Security & *Nonproliferation list* Department of State -wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><!--filename="OFAC Check Results @name@ @dateDefense 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 (currentdateGSA)@"--><u>OFACS CHECK RESULTS</u><br />* Financial Crimes Enforcement Network* FinCEN Money Services Business* World Bank Ineligible Firms* Terrorist Exclusion List* FBI Most Wanted Fugitives
<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>
<br />@ssGet(OFACWhen utilizing Lexis Nexis,company;;@name@;;;;3;;Top 5 Staffthe settings for which watch list services will be included in each scan,Board Officer;;<strong>[[entity]] Search:</strong> [[name]]<br /><strong>Matches Found:</strong> [[recordcount]]<br>;;Result #[[index]]<ul><li>ID: [[id]]</li><li>Name: [[name]]</li><li>Type: [[type]]</li><li>Details: [[details]]</li><li>Score: [[score]]</li></ul>)@<br /><br /><br />Date/time check performed: <!--@sscalculation(DATE_FORMAT("@datetime(currentdate)@"along with threshold settings,"%m/%d/%Y % %h:%i%p"))--> Ewill be managed within your Lexis Nexis account and not within the SmartSimple instance.S.T.<br />Performed by: @me.fullname@<br /><br /></pre>
===Returning information from Watch List===
The syntax for configuring the Watch List check is as follows:
:: <span style="font-size: medium;">'''@ssGet(ServiceName,entity;;firstname;;lastname;;search options;;roleslist;;meta template;;line template<span style=Returning information from Watchlist=="color: #ff0000;">;;''additional search attribute''</span>)@'''</span>The ServiceName is dependent on which third party service you are utilizing:
SmartSimple, in partnership with our Watch List provider (: CSI Web) can provide access : WatchList: Lexis Nexis: LexisNexisThe line template portion of the syntax allows you to a more 3rd party services lists than simply include unique values and parameters in the OFAC listscan criteria, although such as date of birth or country. These values and the client must pay for variables that correspond to them are unique to CSI Web and Lexis Nexis and will require reviewing the individual serviceprovider's fields and available options.<pre style="padding-left: 30px;">@parent.client. The list xml.Board of supported 3rd party services includes 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>*U.S. Bureau Of Industry and Security{| class="xmlSectionTable"*Department of State |- Bureau of International Security & *Nonproliferation list *Department of State ! class="xmlHead"|Result! class="xmlHead"|ID! class="xmlHead"|Name! class="xmlHead"|Type! class="xmlHead"|Alias! class="xmlHead"|Details! class="xmlHead"|Score|- Defense Trade Controls Debarred Parties list id="matchfound"| class="xmlCell"|[[index]]| class="xmlCell"|[[id]]| class="xmlCell"|[[name]]| class="xmlCell"|[[type]]||[[alias]]||[[details]]| class="xmlCell"|[[score]]*International Criminal Police Organization (INTERPOL|}<pre>;;unparsedname=~Name.nodevalue~)$#]@<br /><br />*Politically Exposed Persons@ssGet(LexisNexis, CIA Foreign Officialspeople;;@firstname@;;@lastname@;;1;;;;<strong>Applicant Search:</strong> @firstname@ @lastname@<br />Matches Found: [[recordcount]];;</pre>{| class="xmlSectionTable"|-! class="xmlHead"|Result! class="xmlHead"|ID*Office of Inspector General! class="xmlHead"|Name! class="xmlHead"|Type! class="xmlHead"|Alias! class="xmlHead"|Details*Excluded Parties List System provided by the General Services Administration (GSA)! class="xmlHead"|Score*Financial Crimes Enforcement Network||[[alias]]*FinCEN Money Services Business||[[details]]*World Bank Ineligible Firms | class="xmlCell"|[[score]]*Terrorist Exclusion List|}*FBI Most Wanted Fugitives <pre>;;)@[[index]][[id]][[name]][[type]]
To check values stored as text, rather than actual Organization or Contact records the following syntax can be used. The 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;;
<strong>Board Member Search:</strong> ~Name.nodevalue~<br />Matches Found: [[recordcount]];;
<table class="xmlSectionTable"><tr><th class="xmlHead">Result</th><th class="xmlHead">ID</th><th class="xmlHead">Name</th>
<th class="xmlHead">Type</th><th class="xmlHead">Alias</th><th class="xmlHead">Details</th><th class="xmlHead">Score</th></tr>
<tr id="matchfound"><td class="xmlCell">[[index]]</td><td class="xmlCell">[[id]]</td><td class="xmlCell">[[name]]</td>
<td class="xmlCell">[[type]]</td><td>[[alias]]</td><td>[[details]]</td><td class="xmlCell">[[score]]</td></tr></table>
;;unparsedname=~Name.nodevalue~)$$#]@
</pre>
==Returning information from the online Configuration - U.S. Census databaseOnline Database==
@ssGet(FFD,FIPS;;@address@ @city@ @state@)@<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>)'''
==Returning information from [[:Category:Janus|Janus]]==
@ssGet(JANUS,modelname)@
==See Also==
:* [[Census Integration]]:* [[OFAC, IRS, CRA Checks|OFAC, IRS and CRA Checks]]* [[:Category:Janus|Janus, SmartSimple’s Machine Learning toolIntegration]] [[Category:IntegrationExternal Data Source]][[Category:Variables]]
<!-- OFAC OFACS ofac ofacs OFACs -->
