Smartstaff, administrator
3,320
edits
Changes
→General Overview
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)=={{BillableTemplate: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.
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>
===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 arguments are as followscontent 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.
:* U.S. Bureau Of Industry and Security:* Department of State <span style="font- Bureau of International Security & *Nonproliferation listsize:* Department of State - Defense Trade Controls Debarred Parties list:* International Criminal Police Organization medium;">'''@ssGet(INTERPOL):* Politically Exposed PersonsServiceName, CIA Foreign Officialsentity;;firstname;;lastname;;search options;;roleslist;;meta template;;line template<span style="color:* 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 FugitivesTo 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 #ff0000;">;;''additional search attribute''Board of Directors</span>)@'''</span>The ServiceName is dependent on which third party service you are utilizing:
: CSI Web: WatchList: Lexis Nexis: LexisNexisThe 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.<prestyle="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>
{| class="xmlSectionTable"
| class="xmlCell"|[[score]]
|}
<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>
==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>)'''
==See Also==
:* [[Census Integration]]
:* [[OFAC, IRS, CRA Checks|OFAC, IRS and CRA Checks]]
[[Category:Integration]][[Category:External Data Source]][[Category:Variables]]
<!-- OFAC OFACS ofac ofacs OFACs -->
