Difference between revisions of "SsGet"

Revision as of 16:24, 2 December 2014

The ssGet variable is used to extract information from databases, including the OFAC (Office of Foreign Assets Control) database, U.S. census data and 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 Office of Foreign Assets Control (OFAC)

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:

In the above illustration, the OFAC 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)@

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"

• 1-search current object only (people or company entity),
• 2-search people underneath (company entity only)
• 3-search current object and people underneath (company entity 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: variabels (entity,name,recordcount,now), 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 : variabels (index,id,name,type,details,score), default template will be used if empty

Example : <tr><td>index</td><td>id</td><td>name</td><td>type</td><td>details</td><td>score</td></tr>

Example: put this “@GovValidation(OFAC;;company;;@name@;;;;3;;Board of Advisors;;;;)@” on a company called “Sarah” web page view field results this

Returning information from the online U.S. Census 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]])

Returning information from Janus

@ssGet(JANUS,modelname)@

See Also

• Census Integration
• OFAC, IRS and CRA Checks
• Janus, SmartSimple’s Machine Learning tool