__NOTOC__
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]], Watch List Integration third party providers, 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)==
{{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|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.
: <span style="font-size: medium;">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</span>
The syntax components 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)
* ''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)||rolelist** 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:* ''<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>''
: 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''.''<nowiki>Example:[[index]][[id]][[name]][[type]][[details]][[score]]</nowiki>''|}
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 following is an example content of the configuration of Web Page View may be configured simiarly to the above displayexample shown below:
:: [[Image:OFACCheckWPVConfigOFAC WPV.png|link=|600px800px]]:: '''''Text version here:When using a Web Page View field, you have the option to 'Enable Save to Server''''<pre style="white-space: -o-pre-wrap; word-wrap: break-word;"><!--filename="OFAC Check Results @name@ @date(currentdate)@"--><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 within the "Save field settings. This will allow you to Server as define an upload field on the organization profile where the stored PDF" button above"</div><pre style="white-space: -o-pre-wrap; word-wrap: break-word;"><br />@ssGet(copy of the OFAC,company;;@name@;;;;3;;Top 5 Staff,Board Officer;;<strong>[[entity]] Search:</strong> [[name]]<br /><strong>Matches Found:</strong> [[recordcount]]<br />;;Result #[[index]]</pre>:* ID: [[id]]:* Name: [[name]]:* Type: [[type]]:* Details: [[details]]:* Score: [[score]]results will be saved when triggered.
<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>
{{Template:Watchlist}}
