0
edits
Changes
no edit summary
__NOTOC__
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.
==Returning information from the Office of Foreign Assets Control (OFAC)==
{{Billable}}
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 />
[[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:
:<span style="font -size="3: medium;">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</fontspan>The arguments 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"
* ''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>'':*''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: <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:
::[[Image:OFACCheckWPVConfig.png|600px|link=|600px]] ::'''''Text version here:''''': <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><!--filename="OFAC Check Results @name@ @date(currentdate)@"--><uspan style="text-decoration: underline;">OFACS CHECK RESULTS</uspan><br /pre> <div style="pd4ml-display:none;border:2px #009900 solid;background-color:#FFFF66ffff66;padding:10px;font-family:arial;">Save these results by clicking the "Save to Server as PDF" button above"</div> <pre style="white-space: -o-pre-wrap; word-wrap: break-word;"><br />@ssGet(OFAC,company;;@name@;;;;3;;Top 5 Staff,Board Officer;;<strong>[[entity]] Search:</strong> [[name]]<br /><strong>Matches Found:</strong> [[recordcount]]<br/>;;Result #[[index]]<ul><li/pre>:* ID: [[id]]</li><li>:* Name: [[name]]</li><li>:* Type: [[type]]</li><li>:* Details: [[details]]</li><li>:* Score: [[score]]</li></ulpre style="white-space: -o-pre-wrap; word-wrap: break-word;">)@
<br />
<br />
==Returning information from Watchlist==
{{Billable}}
The syntax for configuring the Watch list check is as follows:
::<span style="font -size="3: medium;">'''@ssGet(WatchList,entity;;firstname;;lastname;;search options;;roleslist;;meta template;;line template)@'''</fontspan>: 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 . . .
</pre>
==See Also==
:* [[Census Integration]]:* [[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]]
<!-- OFAC OFACS ofac ofacs OFACs -->