https://wiki.smartsimple.com/api.php?action=feedcontributions&user=DEardley&feedformat=atomSmartWiki - User contributions [en-gb]2024-03-29T02:06:03ZUser contributionsMediaWiki 1.27.1https://wiki.smartsimple.com/index.php?title=SmartCheck_Validation&diff=40388SmartCheck Validation2022-11-22T21:03:39Z<p>DEardley: /* Requested Amount less than X */</p>
<hr />
<div>=Overview=<br />
SmartCheck Validation is a secure server side validation method. It enables custom field validation ensuring that applications and form inputs meets specified criteria and returns. It provides a better user experience than other validation methodologies and is preferred over Submit Logic. With SmartCheck, the user can see error messages in context and in one central place.<br />
<br />
Before SmartCheck Validation, some error message would pop up individually, one after another, and some messages would appear in one box at the top, depending on how you setup your validation.<br />
<br />
[[image:Smartcheck validationOLD.png]]<br />
<br />
<br />
With SmartCheck Validation and the message type of '''Field''', you will see all messages in one central spot as well as in context messages. See image below.<br />
<br />
<br />
[[image:Smartcheck validation1.png]]<br />
<br />
Clicking on the '''x''' within the in context error message, such as the description field above, enables you to temporarily hide the message. Clicking the error message at the top will bring the cursor to the field where the error is present (if there is a corresponding input). The context error message will also disappear when you have modified the value within field in question.<br />
<br />
<br />
Before you can use SmartCheck validation you must . . .<br />
<br />
1. Configure SmartCheck Validation<br />
<br />
2. Add SmartCheck Validation to Submit Button<br />
<br />
3. Enable SmartCheck Validation<br />
<br />
Note that once you turn on SmartCheck Validation it is enabled everywhere. If you already set up submit logic or other validation before you turned on SmartCheck validation, you will need to test your validation to ensure it works as expected and or replace it with SmartCheck validation.<br />
<br />
<br />
<br />
=Configure SmartCheck Validation=<br />
SmartCheck Validation can be configured for each object type in the system (i.e. individual [[Entity|UTA Level 1/2/3]], company, user, transaction) and then be attached to a Submit button.<br />
<br />
<br />
1. Each entity will have a SmartCheck Validation link available in the corresponding Settings page. Click on this to begin the process of configuring the SmartCheck validation statements.<br />
<br />
[[Image:SmartCheck1.png|700px]]<br />
<br />
<br />
2. The Smartcheck Validation list view will display. There will be a '''New Validation''' button along the top. Click this.<br />
[[Image:SmartCheckLV.png|800px]]<br />
<br />
3. The SmartCheck validation screen will display, comprised of the following 3 tabs . . .<br />
<br />
* Main<br />
* Code Builder<br />
* Source<br />
<br />
<br />
4. Enter appropriate name and description text into the relevant fields on the Main tab and click Save.<br />
<br />
[[Image:SmartCheck2.png|800px]]<br />
<br />
<br />
5. Navigate to the Code Builder tab to add validation using 2 possible approaches.<br />
<br />
* ''New validation:'' Use the drop-downs at the top of the screen to create new validation. Further details on the options available are provided in the SmartCheck Validation Structure section below.<br />
<br />
[[Image:SmartCheck3.png|800px]]<br />
<br />
<br />
<br />
* ''Existing Submit Logic'': Use the drop-down at the bottom of the screen to select a submit button and any existing validation associated with this button.<br />
<br />
[[Image:SmartCheck4.png|800px]]<br />
<br />
<br />
6. Click on the Insert button under the relevant section. This will take you to the Source tab, and show the updated validation statement.<br />
<br />
[[Image:SmartCheck5.png|800px]]<br />
<br />
<br />
7. Click the Save button to store all changes.<br />
<br />
8. Use the Trial Run at the bottom of the Source tab to check whether there are errors when the validation statements run.<br />
<br />
<br />
<br />
=Add SmartCheck Validation to Submit Button=<br />
Once the validation statements are created you can start to add the logic to [[Submit & Save Buttons|Submit or Save buttons]].<br />
<br />
1. Each entity will have a [Submit & Save Buttons]] link available in the corresponding Settings page. Click on this to begin the process of adding the SmartCheck validation statements to a button.<br />
<br />
[[Image:Submit and save button1.png|700px]]<br />
<br />
<br />
2. The Submit & Save Buttons page is displayed, showing a list of configured buttons. Click on the Edit button for the one you wish to edit.<br />
<br />
<br />
3. Select the SmartCheck Validation option from the corresponding drop-down<br />
<br />
[[Image:SmartCheck6.png|800px]]<br />
<br />
<br />
4. Click Save at the bottom of the page.<br />
<br />
<br />
<br />
=Enable SmartCheck Validation=<br />
# In the top header, click the '''Configuration''' drop down.<br />
# Select '''Global Settings'''.<br />
# On the first tab called System, Check the box beside '''Activate SmartCheck Validation'''.<br />
# Click '''Save'''.<br />
<br />
<br />
<br />
=SmartCheck Update History=<br />
Changes to the SmartCheck logic can be tracked using the Update History feature, which is available against each configured SmartCheck validation.<br />
<br />
[[Image:SmartCheckHistory.png]]<br />
<br />
<br />
If user clicks on the Update History button then are presented with an overview of all changes made to that specific SmartCheck validation, including date and time and the person who made the change.<br />
[[Image:SmartCheckHistory2.png|600px]]<br />
<br />
<br />
Users can also compare versions by checking the box on the left of the list view and then clicking on the Compare button.<br />
[[Image:SmartCheckHistory3.png|500px]]<br />
<br />
<br />
Users will be presented with screen showing differences between the 2 versions.<br />
<br />
[[Image:SmartCheckHistory4.png|600px]]<br />
<br />
=SmartCheck Validation Structure=<br />
Each SmartCheck Validation statement shares the following structure:<br />
<br />
* '''If''' Statement (condition to be tested)<br />
* '''Result''' (assigned result based on the condition)<br />
* '''Message''' (to be displayed when result is false)<br />
<br />
<br />
In the example below:<br />
<br />
<pre>if(ssParseNum(form.getStr("cf_Store Value")) > 5)<br />
{result.isPassed=false;<br />
result.addMsg('Some message here');<br />
}<br />
</pre><br />
<br />
If custom field is a currency and the format will change based on different locales, use ssParseNumFromCurrency(value,locale,getnumtype,emptyok):<br />
<br />
- "@sslocale@" returns the logged in user's locale, e.g. "fr-CA"<br />
<br />
- getnumtype: 1=real number (10000,78 becomes 10000.78), 2=formatted currency (10000,78)<br />
<br />
- emptyok: field can be empty<br />
<br />
Example: ssParseNumFromCurrency("10000,78","fr-CA",1,true) will return 10000.78<br />
<br />
<pre>if(ssParseNumFromCurrency(form.getStr("cf_myCADcurrency"),"@sslocale@",1,true) > 5)<br />
{result.isPassed=false;<br />
result.addMsg('Some message here');<br />
}<br />
</pre><br />
For other currencies with format regardless of user's locale, such as DKK, it can be implemented as:<br /> ssParseNumFromCurrency(value,getLocalestrByCurrency('DKK'),1,true) OR ssParseNumFromCurrency(value,"da-DK",1,true)<br />''(getLocalestrByCurrency will get the "default" locale of the currency code)''<br />
<br />
<pre>if(ssParseNumFromCurrency(form.getStr("cf_myDKKcurrency"),"da-DK",1,true) > 5)<br />
{result.isPassed=false;<br />
result.addMsg('Some message here');<br />
}<br />
</pre><br />
<br />
Recognize the If, Result, Message structure:<br />
<br />
<pre>if(ssParseNum(form.getStr("cf_Store Value")) > 5)<br />
</pre><br />
Check '''If''' the contents the of the form value (stored in the custom field named cf_Store_Value) is greater than 5,<br />
<br />
<pre>{result.isPassed=false;<br />
</pre><br />
Assign the value of the '''Result''' to '''"false"''' and print the custom message below.<br />
<br />
<pre>result.addMsg('Some message here');<br />
}<br />
</pre><br />
<br />
=Form Value vs Stored Value=<br />
In the SmartCheck code builder there is a select where you choose between '''Form Value''' and '''Stored Value'''. The '''Form Value'''' is the value someone has entered into his or her application (form), this includes information that has not been saved. The '''Stored Value''' is the value from the server (information that has been saved). By using the '''Form Value''' you can validate based on information that the user has entered into the form even if they have not clicked save on their application.<br />
<br />
<br />
Here is how it looks when you call the Form Value for a standard field:<br />
<br />
<pre>if(form.getStr("sf_Application Name") == "")</pre><br />
<br />
Here is how it looks when you call the Stored Value for the same standard field:<br />
<br />
<pre>if("@Application Name@" == "")</pre><br />
<br />
Notice the stored value calls the field using the variable syntax we learned in the variable processor lesson.<br />
<br />
<br />
<br />
=Field vs System Messages=<br />
In the SmartCheck code builder there is a select where you can choose between '''Field''' and '''System''' Messages. '''Field''' messages appear both at the top of the application and on the field that failed validation, this type is recommended for most validations. '''System''' messages appear only at the top of the application. You might use System messages when your validation compares more than one field, as it may not be obvious which field to highlight with the error message.<br />
<br />
<br />
Here is how it looks when you call a system message:<br />
<br />
<pre>result.addMsg('Your message goes here.'); }</pre><br />
<br />
Here is how it looks when you call a Field message on a custom field:<br />
<br />
<pre>result.addMsg('cf_@field name.id@', 'Your message goes here.); }</pre><br />
<br />
Notice the field name is added before your message, so the system knows where to place the validation message, and the system knows where to bring your cursor should you click the message.<br />
<br />
<br />
<br />
=Configuring Messages for Multilingual Systems=<br />
Messages can also be displayed in different languages based on the user's language of choice within the portal. The langid variable for the language must be included within the syntax to tie the message to a particular language setting.<br />
<br />
<br />
The message below would only be shown for the English language:<br />
<br />
<pre>result.addMsg('Your message goes here.', 1); }</pre><br />
<br />
The langid could also be used for Field messages:<br />
<br />
<pre>result.addMsg('cf_@field name.id@', 'Your message goes here.', 1); }</pre><br />
<br />
And the following is an example with multiple languages:<br />
<br />
<pre>if(((form.getStr("cf_Strategy").length() - form.getStr("cf_Strategy").replace(';','').length())>4))<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Strategy.id@','You can pick up to 4 primary strategies you use.', 1);<br />
result.addMsg('cf_@Strategy.id@','Puedes elegir 4 estrategias principales.', 14);<br />
result.addMsg('cf_@Strategy.id@','Vous pouvez choisir à 4 stratégies primaires', 6);<br />
result.addMsg('cf_@Strategy.id@','Você pode escolher 4 estratégias primárias.', 16);<br />
}<br />
</pre><br />
<br />
'''Important:''' The langid variable cannot be selectively applied to the messages, it must be included in every SmartCheck message within the system.<br />
<br />
=Examples=<br />
===Check an amount is greater than $100,000===<br />
<pre>if(ssParseNum(form.getStr("cf_Amount Requested")) > 100000)<br />
{result.isPassed=false; <br />
result.addMsg('cf_@Amount Requested.id@','Amount Requested cannot exceed $100,000');<br />
}</pre><br />
<br />
===Application Name field blank===<br />
<pre>if(form.getStr("sf_Application Name") == "")<br />
{result.isPassed=false;<br />
result.addMsg('Application name cannot be blank');<br />
}</pre><br />
<br />
===Requested Amount less than X===<br />
<pre>if(ssParseNum(form.getStr("cf_Requested Amount")) < 5000)<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Requested Amount.id@','Field test message');<br />
}</pre><br />
<br />
===Number value greater than 5===<br />
<pre>if(ssParseNum(form.getStr("cf_Store Value")) > 5)<br />
{result.isPassed=false;<br />
result.addMsg('Some message here');<br />
}<br />
</pre><br />
<br />
===Single field upload field has no file===<br />
<pre>if("@Single File Field.filename@" == "")<br />
{result.isPassed=false;<br />
result.addMsg('Please upload a file here');<br />
}<br />
</pre><br />
<br />
===Multi file upload field has no files===<br />
<pre>if(ssParseNum("@level1.MUlti upload.numoffiles@") < 1)<br />
{result.isPassed=false;<br />
result.addMsg('Please upload at least one file');<br />
}</pre><br />
<br />
===Dynamic XML field has no entries===<br />
<pre>if("@xml.fieldname.sectionnodename.rownodename.nodecount@"==0)<br />
{result.isPassed=false;<br />
result.addMsg('xml_@fieldname.id@','At least one entry is required in the XML worksheet.');<br />
}</pre><br />
<br />
===Comparing two custom date fields with separate custom time fields storing 24 hour time===<br />
<pre>if(ssConvertDate(form.getStr("cf_Event Start Date"),"@dateformat@", "yyyy-mm-dd")+' '+form.getStr("cf_Event Start Time") >= ssConvertDate(form.getStr("cf_Event End Date"),"@dateformat@", "yyyy-mm-dd")+' '+form.getStr("cf_Event End Time"))<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Event End Time.id@','End Date must take place after the Start Date');<br />
}</pre><br />
<br />
===Comparing a date custom field to the current date===<br />
<pre>if ((ssConvertDate(form.getStr("cf_Individual Review Start Date"), "@dateformat@", "yyyy-mm-dd") > "@date(currentdate)@")) <br />
{result.isPassed = false; <br />
result.addMsg('cf_@Individual Review Start Date.id@', 'Please enter a date less than or equal to today for the date.');<br />
}<br />
</pre><br />
<br />
===Comparing a date custom field to a date that is six months ago (date must be at least six months ago)===<br />
<pre>if(ssConvertDate(form.getStr("cf_Date"),"@dateformat@", "yyyy-mm-dd") > "<!--@sscalculation(DATE_ADD('@date(currentdate)@', INTERVAL -6 MONTH))-->")<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Date.id@','Date must be at least 6 months prior to today's date');<br />
}</pre><br />
NOTE: When using @sscalculation, you <u>must</u> wrap the syntax in double quotes<br />
<br />
===Ensuring an entered date is at least 3 business days away===<br />
<pre>if(ssConvertDate(form.getStr("cf_Date EOI Revision Deadline"),'@dateformat@','yyyy-mm-dd') < "<!--@sscalculation(SS_FUNC.addbusdays("@date(currentdate)@",3))-->")<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Date EOI Revision Deadline.id@','Date must be at least 3 business days away');<br />
}</pre><br />
NOTE: When using @sscalculation, you <u>must</u> wrap the syntax in double quotes<br />
<br />
===Date custom field blank===<br />
<pre>if ((ssConvertDate(form.getStr("cf_Project Start Date"), "@dateformat@", "yyyy-mm-dd") == "yyyy-mm-dd")) <br />
{result.isPassed = false;<br />
result.addMsg('cf_@Project Start Date.id@', 'Project Start Date is a required field.');<br />
}</pre><br />
<br />
===Validation on a Select Many Checkbox Field===<br />
<pre>if(form.getStr("cf_Request Type").indexOf("General Operating")==-1 )<br />
{result.isPassed=false;<br />
result.addMsg('General Operating was not selected');<br />
}</pre><br />
To trigger when the value is selected, use '!=-1'. This would normally be used in combination with another field for validations.<br />
<br />
===Select Many Checkbox field has at least 5 values selected===<br />
<pre>if(((form.getStr("cf_Check Box Field").length() - form.getStr("cf_Check Box Field").replace(';','').length())<=4))<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Check Box Field.id@','At least 5 items must be selected.');<br />
}</pre><br />
<br />
===At least one role is selected on a contact===<br />
<pre>if('@rolelist@' == "")<br />
{result.isPassed=false;<br />
result.addMsg('At least one role must be selected.');<br />
}</pre><br />
<br />
===Validation on an e-mail field===<br />
<pre>if(!isEmail(form.getStr("cf_Additional Email 1")))<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Additional Email 1.id@','Please enter a valid e-mail address.');<br />
}</pre><br />
<br />
===Validate that the status of the organization is Active===<br />
<pre>if("@client.status@" != "Active")<br />
{result.isPassed=false;<br />
result.addMsg('Please update your Organization Profile then return to this record and click Submit Application.'); <br />
}</pre><br />
<br />
===Validation on a Note Enabled Multiple-Line custom field===<br />
When validating against a Note Enabled field, within the result.addMsg() alert you will need to include '''h''' in-front of the custom field reference.<br />
<br />
<pre>if(form.getStr("cf_notefield")==""){<br />
result.isPassed= false;<br />
result.addMsg("cf_h@notefield.id@","You must type in a description before submitting for revisions.");<br />
}</pre><br />
<br />
===Minimum word count limit===<br />
Used on multiline text fields to limit the minimum word entry<br />
<br />
<pre>if(form.getStr("cf_Leadership").split(' ').length < 100)<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Leadership.id@','Leadership question must have minimum 100 words'); }</pre><br />
<br />
===Count contacts in a specific role===<br />
Used to ensure at least one contact is attached to the record in a specific role<br />
<br />
<pre>if("@level1.[#(?object=contact::criteria=rolename IN ('Panel Reviewer - Pending','Panel Reviewer - Accepted')::groupfunction=count)~userid~#]@" < "1")<br />
{result.isPassed=false;<br />
result.addMsg("Please assign reviewers in the Panel Reviewer Pending or Panel Reviewer Accepted role."); }</pre><br />
<br />
===Defining VAR Variables===<br />
Using var javascript variables to define values to be evaluated within the SmartCheck Validation.<br />
<br />
<pre>var countWatch="[#(?object=activity::criteria=typename='Watchlist Scan' and statusname='Scan Run')~count(eventid)~#]";<br />
<br />
if(countWatch=="0")<br />
{result.isPassed=false;<br />
result.addMsg('Please run a watchlist scan.');<br />
}</pre><br />
<br />
<br />
==To include other scripts into a SmartCheck script:==<br />
<pre>//@include(AnotherSmartCheckScriptName)@<br />
</pre><br />
<br />
<br />
==See Also==<br />
* [[Submit buttons]]<br />
* [[Status]]<br />
* [[Submit Logic on Save or Save Draft Buttons]]<br />
<br />
<br />
[[Category:Applications]][[Category:Global Settings]][[Category:Validation]][[Category:How]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Including_Criteria_in_ReportProperty&diff=39627Including Criteria in ReportProperty2022-04-05T19:55:30Z<p>DEardley: </p>
<hr />
<div>This article describes the syntax used with the [[ReportProperty]] [[Variables|variable]] in order to pass [[Parameter|parameters]] to a report to be used as report [[:Category:Criteria|criteria]].<br />
<br />
<br />
<br />
==Syntax for passing static parameters to a report==<br />
: <span style="font-size: medium;">@ReportProperty(''reportid'',''property'',,"''criteria''")@</span><br />
'''Where:'''<br />
<br />
* ''reportid'' is the system ID for the report (see [[Determining the reportid]]). The ReportProperty syntax also supports the Report Name, but you must ensure the Report Name does not include any special characters.<br />
* ''property'' can be:<br />
** '''recordcount''' - Count of the number of records within a specified report<br />
** '''csvdata''' - Report data, with each field separated by commas<br />
** '''exportdata''' - Report data, formatted as defined in the [[Exporting Reports|Advanced Export]] settings of the Report<br />
* ''criteria'' is the answer to the ??? in the report referenced by the reportid<br />
<br />
'''Example''':<br />
<br />
* The report with reportid 12345 has a [[Prompting for Criteria in Reports|criteria]] on a date field of "=???"<br />
* To generate the number of records in the report with a date of 2009-10-26:<br />
<br />
@ReportProperty(12345,recordcount,,"2009-10-26")@<br />
<br />
==Syntax for dynamic parameters to a report==<br />
: <span style="font-size: medium;">@ReportProperty2(''reportid'',''property'',,"''@criteria@''")@</span><br />
<br />
'''Where:'''<br />
<br />
* ''reportid'' is the system ID for the report (see [[Determining the reportid]])<br />
* ''property'' can be:<br />
** '''recordcount''' - Count of the number of records within a specified report<br />
** '''csvdata''' - Report data, with each field separated by commas<br />
** '''exportdata'''- Report data, formatted as defined in the [[Exporting Reports|Custom Export]] settings of the Report<br />
* ''criteria'' is the variable that returns the answer to the ??? in the report referenced by the reportid<br />
<br />
==Syntax for passing multiple parameters to a report==<br />
: <span style="font-size: medium;">@ReportProperty2(''reportid'',''property'',,"@''criteria1''@::@''criteria2''@")@</span><br />
'''Where:'''<br />
<br />
* ''reportid'' is the system ID for the report (see [[Determining the reportid]])<br />
* ''property'' can be:<br />
** '''recordcount''' - Count of the number of records within a specified report<br />
** '''csvdata''' - Report data, with each field separated by commas<br />
** '''exportdata'''- Report data, formatted as defined in the [[Exporting Reports|Advanced Export]] settings of the Report<br />
* ''criteria1'', ''criteria2'', etc. are the variable that returns the answer to the ??? prompts in the report referenced by the reportid. ''Criteria1'' is matched against the first instance of the ??? prompt in the [[Report Builder]], ''criteria2'' is matched against the second instance, etc., working from left to right.<br />
<br />
'''Example''':<br />
<br />
* The report with reportid 12345 has [[Prompting for Criteria in Reports|criteria]] on a date field of ">=???" and "<=???"<br />
* To generate the number of records in the report with a date range of startdate to enddate:<br />
<br />
@ReportProperty2(12345,exportdata,,"@fullstartdate@::@fullenddate@")@<br />
<br />
==Notes==<br />
<br />
* Use double quotes, not single quotes, to encapsulate criteria.<br />
* Note that if the ReportProperty variable is used in a Custom Field the report will be run every time the record is opened. Therefore, use this functionality sparingly or server performance may be impacted. Consider putting the ReportProperty onto a [[Custom Field Type: Display Only – Web Page View|web page view]] on the record, so it can be executed/viewed on-demand.<br />
* [[Read Only - System Variable|Read Only]] fields with ReportProperty should '''never''' be included in [[List View]]s. (All Read Only fields should be avoided when creating [[List Views]])<br />
<br />
<br />
<br />
==See Also==<br />
* [[Using Variables in the Report Builder]]<br />
* [[Reportproperty|Report Variables]]<br />
* [[Passing Values Using Parameters]]<br />
* [[Prompting for Criteria in Reports]]<br />
<br />
[[Category:Variables]][[Category:Reports]][[Category:Criteria]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Report_Variables&diff=39626Report Variables2022-04-05T19:55:00Z<p>DEardley: </p>
<hr />
<div>This article describes the [[Variables]] that can be used to display report data, or properties of reports.<br />
<br />
'''For details on [[Variables]] that can be used when creating reports see [[Using Variables in the Report Builder]].'''<br />
<br />
<br />
==Syntax==<br />
: <span style="font-size: medium;">@ReportProperty(''reportid'',''property'')@</span><br />
<br />
'''Where:'''<br />
<br />
* ''reportid'' is the system ID for the report (see [[Determining the reportid]]). The ReportProperty syntax also supports the Report Name, but you must ensure the Report Name does not include any special characters.<br />
* ''property'' can be:<br />
** '''recordcount''' - Count of the number of records within a specified report<br />
** '''csvdata''' - Report data, with each field separated by commas<br />
** '''exportdata''' - Report data, formatted as defined in the [[Exporting Reports|Custom Export]] settings of the Report<br />
** '''exportrawdata''' - Report data, without any formatting<br />
<br />
'''Note:'''<br />
<br />
*:* ''ReportProperty'' is case sensitive. Using ''reportproperty'' will not work.<br />
<br />
* <br />
===Using ReportProperty on reports with a Group By===<br />
<br />
*:* In order to use a ReportProperty on a report which has a group by clause, you need to add a distinct clause to the ReportProperty syntax.<br />
<br />
* <br />
@ReportProperty(''reportid'',''property'',distinct(''fieldname''))@<br />
Example: If a report is grouped by the tracking id, then your ReportProperty syntax would be<br />
@ReportProperty(''reportid'',''property'',distinct(opportunityid))@<br />
<br />
You can also pass '''criteria''' into the ReportProperty call. See [[Including Criteria in ReportProperty]].<br />
<br />
==Record Count==<br />
'''recordcount''' can be used:<br />
<br />
*:* In a [[Web Page View]] or as a [[Custom Field Type: Read Only – System Variables|Read Only - System Variable]] to display a record count<br />
*:* As part of [[Submit Logic]] to ensure a certain condition is met prior to submission of a record.<br />
*:* Included in the title of a [[Portal]] shortcut to indicate how many records are at a given status (for example)<br />
<br />
* <br />
<br />
'''Examples''':<br />
<br />
** To generate the number of records (equivalent to the number of rows in the report) for report with ID 12345<br />
@ReportProperty(12345,recordcount)@<br />
<br />
<br />
** To display the number of records at a given status in a Portal Icon:<br />
*: [[Image:CMPortal.png]]<br />
* <br />
Will display as:<br />
<br />
*: [[Image:PIcon.png]]<br />
* <br />
<br />
<br />
==CSV Data==<br />
When using the '''csvdata''' report variable, the variable will be replaced with data from the specified report, as comma separated values.<br />
<br />
*: <span style="font-size: medium;">@ReportProperty(''reportid'',csvdata)@</span><br />
* <br />
<br />
''The csvdata variable can be used in a [[Web Page View]] or [[Custom Field Type: Read Only – System Variables|Read Only - System Variables]] custom field, or be included in the body of a [[Workflow]] message.''<br />
<br />
'''csvdata''' is most often used within the body of a plain-text workflow e-mail.<br />
<br />
When using the '''csvdata''' variable the header and footer defined on the [[Report Export]] page will be used.<br />
<br />
==Export Data==<br />
When using the Exportdata report variable, the variable will be replaced with data from the specified report, in the format defined by the custom export template.<br />
<br />
*: <span style="font-size: medium;">@ReportProperty(''reportid'',exportdata)@</span><br />
* <br />
<br />
''The exportdata variable can be used in a [[Web Page View]] or [[Custom Field Type: Read Only – System Variables|Read Only - System Variables]] custom field, or be included in the body of a [[Workflow]] message.''<br />
<br />
Most often '''exportdata''' is used with report export settings defined as HTML.<br />
<br />
<br />
==Export Raw Data==<br />
When using the Exportrawdata report variable, the variable will be replaced with data from the specified report, without any formatting applied.<br />
<br />
*: <span style="font-size: medium;">@ReportProperty(''reportid'',exportrawdata)@</span><br />
* <br />
<br />
''The exportrawdata variable can be used in a [[Web Page View]] or [[Custom Field Type: Read Only – System Variables|Read Only - System Variables]] custom field, or be included in the body of a [[Workflow]] message.''<br />
<br />
==Notes==<br />
<br />
** When using any of the ReportProperty variables (recordcount, exportdata and csvdata) the object ID ([[opportunityid]], [[eventid]], [[userid]], etc) will be passed to the report processor. If the specified report includes the variable: '''@''objectid''@''', it will be replaced by the object ID of whichever object (Level 1, Level 2, Contact, etc) called the ReportProperty attribute.<br />
<br />
<br />
==See Also==<br />
** [[Including Criteria in ReportProperty]]<br />
** [[Using Variables in the Report Builder]]<br />
[[Category:Variables]][[Category:Reports]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SmartCheck_Validation&diff=39583SmartCheck Validation2022-03-07T15:53:58Z<p>DEardley: </p>
<hr />
<div>=Overview=<br />
SmartCheck Validation is a secure server side validation method. It enables custom field validation ensuring that applications and form inputs meets specified criteria and returns. It provides a better user experience than other validation methodologies and is preferred over Submit Logic. With SmartCheck, the user can see error messages in context and in one central place.<br />
<br />
Before SmartCheck Validation, some error message would pop up individually, one after another, and some messages would appear in one box at the top, depending on how you setup your validation.<br />
<br />
[[image:Smartcheck validationOLD.png]]<br />
<br />
<br />
With SmartCheck Validation and the message type of '''Field''', you will see all messages in one central spot as well as in context messages. See image below.<br />
<br />
<br />
[[image:Smartcheck validation1.png]]<br />
<br />
Clicking on the '''x''' within the in context error message, such as the description field above, enables you to temporarily hide the message. Clicking the error message at the top will bring the cursor to the field where the error is present (if there is a corresponding input). The context error message will also disappear when you have modified the value within field in question.<br />
<br />
<br />
Before you can use SmartCheck validation you must . . .<br />
<br />
1. Configure SmartCheck Validation<br />
<br />
2. Add SmartCheck Validation to Submit Button<br />
<br />
3. Enable SmartCheck Validation<br />
<br />
Note that once you turn on SmartCheck Validation it is enabled everywhere. If you already set up submit logic or other validation before you turned on SmartCheck validation, you will need to test your validation to ensure it works as expected and or replace it with SmartCheck validation.<br />
<br />
<br />
<br />
=Configure SmartCheck Validation=<br />
SmartCheck Validation can be configured for each object type in the system (i.e. individual [[Entity|UTA Level 1/2/3]], company, user, transaction) and then be attached to a Submit button.<br />
<br />
<br />
1. Each entity will have a SmartCheck Validation link available in the corresponding Settings page. Click on this to begin the process of configuring the SmartCheck validation statements.<br />
<br />
[[Image:SmartCheck1.png|700px]]<br />
<br />
<br />
2. The Smartcheck Validation list view will display. There will be a '''New Validation''' button along the top. Click this.<br />
[[Image:SmartCheckLV.png|800px]]<br />
<br />
3. The SmartCheck validation screen will display, comprised of the following 3 tabs . . .<br />
<br />
* Main<br />
* Code Builder<br />
* Source<br />
<br />
<br />
4. Enter appropriate name and description text into the relevant fields on the Main tab and click Save.<br />
<br />
[[Image:SmartCheck2.png|800px]]<br />
<br />
<br />
5. Navigate to the Code Builder tab to add validation using 2 possible approaches.<br />
<br />
* ''New validation:'' Use the drop-downs at the top of the screen to create new validation. Further details on the options available are provided in the SmartCheck Validation Structure section below.<br />
<br />
[[Image:SmartCheck3.png|800px]]<br />
<br />
<br />
<br />
* ''Existing Submit Logic'': Use the drop-down at the bottom of the screen to select a submit button and any existing validation associated with this button.<br />
<br />
[[Image:SmartCheck4.png|800px]]<br />
<br />
<br />
6. Click on the Insert button under the relevant section. This will take you to the Source tab, and show the updated validation statement.<br />
<br />
[[Image:SmartCheck5.png|800px]]<br />
<br />
<br />
7. Click the Save button to store all changes.<br />
<br />
8. Use the Trial Run at the bottom of the Source tab to check whether there are errors when the validation statements run.<br />
<br />
<br />
<br />
=Add SmartCheck Validation to Submit Button=<br />
Once the validation statements are created you can start to add the logic to [[Submit & Save Buttons|Submit or Save buttons]].<br />
<br />
1. Each entity will have a [Submit & Save Buttons]] link available in the corresponding Settings page. Click on this to begin the process of adding the SmartCheck validation statements to a button.<br />
<br />
[[Image:Submit and save button1.png|700px]]<br />
<br />
<br />
2. The Submit & Save Buttons page is displayed, showing a list of configured buttons. Click on the Edit button for the one you wish to edit.<br />
<br />
<br />
3. Select the SmartCheck Validation option from the corresponding drop-down<br />
<br />
[[Image:SmartCheck6.png|800px]]<br />
<br />
<br />
4. Click Save at the bottom of the page.<br />
<br />
<br />
<br />
=Enable SmartCheck Validation=<br />
# In the top header, click the '''Configuration''' drop down.<br />
# Select '''Global Settings'''.<br />
# On the first tab called System, Check the box beside '''Activate SmartCheck Validation'''.<br />
# Click '''Save'''.<br />
<br />
<br />
<br />
=SmartCheck Update History=<br />
Changes to the SmartCheck logic can be tracked using the Update History feature, which is available against each configured SmartCheck validation.<br />
<br />
[[Image:SmartCheckHistory.png]]<br />
<br />
<br />
If user clicks on the Update History button then are presented with an overview of all changes made to that specific SmartCheck validation, including date and time and the person who made the change.<br />
[[Image:SmartCheckHistory2.png|600px]]<br />
<br />
<br />
Users can also compare versions by checking the box on the left of the list view and then clicking on the Compare button.<br />
[[Image:SmartCheckHistory3.png|500px]]<br />
<br />
<br />
Users will be presented with screen showing differences between the 2 versions.<br />
<br />
[[Image:SmartCheckHistory4.png|600px]]<br />
<br />
=SmartCheck Validation Structure=<br />
Each SmartCheck Validation statement shares the following structure:<br />
<br />
* '''If''' Statement (condition to be tested)<br />
* '''Result''' (assigned result based on the condition)<br />
* '''Message''' (to be displayed when result is false)<br />
<br />
<br />
In the example below:<br />
<br />
<pre>if(ssParseNum(form.getStr("cf_Store Value")) > 5)<br />
{result.isPassed=false;<br />
result.addMsg('Some message here');<br />
}<br />
</pre><br />
<br />
Recognize the If, Result, Message structure:<br />
<br />
<pre>if(ssParseNum(form.getStr("cf_Store Value")) > 5)<br />
</pre><br />
Check '''If''' the contents the of the form value (stored in the custom field named cf_Store_Value) is greater than 5,<br />
<br />
<pre>{result.isPassed=false;<br />
</pre><br />
Assign the value of the '''Result''' to '''"false"''' and print the custom message below.<br />
<br />
<pre>result.addMsg('Some message here');<br />
}<br />
</pre><br />
<br />
=Form Value vs Stored Value=<br />
In the SmartCheck code builder there is a select where you choose between '''Form Value''' and '''Stored Value'''. The '''Form Value'''' is the value someone has entered into his or her application (form), this includes information that has not been saved. The '''Stored Value''' is the value from the server (information that has been saved). By using the '''Form Value''' you can validate based on information that the user has entered into the form even if they have not clicked save on their application.<br />
<br />
<br />
Here is how it looks when you call the Form Value for a standard field:<br />
<br />
<pre>if(form.getStr("sf_Application Name") == "")</pre><br />
<br />
Here is how it looks when you call the Stored Value for the same standard field:<br />
<br />
<pre>if("@Application Name@" == "")</pre><br />
<br />
Notice the stored value calls the field using the variable syntax we learned in the variable processor lesson.<br />
<br />
<br />
<br />
=Field vs System Messages=<br />
In the SmartCheck code builder there is a select where you can choose between '''Field''' and '''System''' Messages. '''Field''' messages appear both at the top of the application and on the field that failed validation, this type is recommended for most validations. '''System''' messages appear only at the top of the application. You might use System messages when your validation compares more than one field, as it may not be obvious which field to highlight with the error message.<br />
<br />
<br />
Here is how it looks when you call a system message:<br />
<br />
<pre>result.addMsg('Your message goes here.'); }</pre><br />
<br />
Here is how it looks when you call a Field message on a custom field:<br />
<br />
<pre>result.addMsg('cf_@field name.id@', 'Your message goes here.); }</pre><br />
<br />
Notice the field name is added before your message, so the system knows where to place the validation message, and the system knows where to bring your cursor should you click the message.<br />
<br />
<br />
<br />
=Configuring Messages for Multilingual Systems=<br />
Messages can also be displayed in different languages based on the user's language of choice within the portal. The langid variable for the language must be included within the syntax to tie the message to a particular language setting.<br />
<br />
<br />
The message below would only be shown for the English language:<br />
<br />
<pre>result.addMsg('Your message goes here.', 1); }</pre><br />
<br />
The langid could also be used for Field messages:<br />
<br />
<pre>result.addMsg('cf_@field name.id@', 'Your message goes here.', 1); }</pre><br />
<br />
And the following is an example with multiple languages:<br />
<br />
<pre>if(((form.getStr("cf_Strategy").length() - form.getStr("cf_Strategy").replace(';','').length())>4))<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Strategy.id@','You can pick up to 4 primary strategies you use.', 1);<br />
result.addMsg('cf_@Strategy.id@','Puedes elegir 4 estrategias principales.', 14);<br />
result.addMsg('cf_@Strategy.id@','Vous pouvez choisir à 4 stratégies primaires', 6);<br />
result.addMsg('cf_@Strategy.id@','Você pode escolher 4 estratégias primárias.', 16);<br />
}<br />
</pre><br />
<br />
'''Important:''' The langid variable cannot be selectively applied to the messages, it must be included in every SmartCheck message within the system.<br />
<br />
=Examples=<br />
===Check an amount is greater than $100,000===<br />
<pre>if(ssParseNum(form.getStr("cf_Amount Requested")) > 100000)<br />
{result.isPassed=false; <br />
result.addMsg('cf_@Amount Requested.id@','Amount Requested cannot exceed $100,000');<br />
}</pre><br />
<br />
===Application Name field blank===<br />
<pre>if(form.getStr("sf_Application Name") == "")<br />
{result.isPassed=false;<br />
result.addMsg('Application name cannot be blank');<br />
}</pre><br />
<br />
===Requested Amount less than X===<br />
<pre>if(ssParseNum(form.getStr("cf_Requested Amount")) < "5000")<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Requested Amount.id@','Field test message');<br />
}</pre><br />
<br />
===Number value greater than 5===<br />
<pre>if(ssParseNum(form.getStr("cf_Store Value")) > 5)<br />
{result.isPassed=false;<br />
result.addMsg('Some message here');<br />
}<br />
</pre><br />
<br />
===Single field upload field has no file===<br />
<pre>if("@Single File Field.filename@" == "")<br />
{result.isPassed=false;<br />
result.addMsg('Please upload a file here');<br />
}<br />
</pre><br />
<br />
===Multi file upload field has no files===<br />
<pre>if(ssParseNum("@level1.MUlti upload.numoffiles@") < 1)<br />
{result.isPassed=false;<br />
result.addMsg('Please upload at least one file');<br />
}</pre><br />
<br />
===Dynamic XML field has no entries===<br />
<pre>if("@xml.fieldname.sectionnodename.rownodename.nodecount@"==0)<br />
{result.isPassed=false;<br />
result.addMsg('xml_@fieldname.id@','At least one entry is required in the XML worksheet.');<br />
}</pre><br />
<br />
===Comparing two custom date fields with separate custom time fields storing 24 hour time===<br />
<pre>if(ssConvertDate(form.getStr("cf_Event Start Date"),"@dateformat@", "yyyy-mm-dd")+' '+form.getStr("cf_Event Start Time") >= ssConvertDate(form.getStr("cf_Event End Date"),"@dateformat@", "yyyy-mm-dd")+' '+form.getStr("cf_Event End Time"))<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Event End Time.id@','End Date must take place after the Start Date');<br />
}</pre><br />
<br />
===Comparing a date custom field to the current date===<br />
<pre>if ((ssConvertDate(form.getStr("cf_Individual Review Start Date"), "@dateformat@", "yyyy-mm-dd") > "@date(currentdate)@")) <br />
{result.isPassed = false; <br />
result.addMsg('cf_@Individual Review Start Date.id@', 'Please enter a date less than or equal to today for the date.');<br />
}<br />
</pre><br />
<br />
===Comparing a date custom field to a date that is six months ago (date must be at least six months ago)===<br />
<pre>if(ssConvertDate(form.getStr("cf_Date"),"@dateformat@", "yyyy-mm-dd") > "<!--@sscalculation(DATE_ADD('@date(currentdate)@', INTERVAL -6 MONTH))-->")<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Date.id@','Date must be at least 6 months prior to today's date');<br />
}</pre><br />
NOTE: When using @sscalculation, you <u>must</u> wrap the syntax in double quotes<br />
<br />
===Ensuring an entered date is at least 3 business days away===<br />
<pre>if(ssConvertDate(form.getStr("cf_Date EOI Revision Deadline"),'@dateformat@','yyyy-mm-dd') < "<!--@sscalculation(SS_FUNC.addbusdays("@date(currentdate)@",3))-->")<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Date EOI Revision Deadline.id@','Date must be at least 3 business days away');<br />
}</pre><br />
NOTE: When using @sscalculation, you <u>must</u> wrap the syntax in double quotes<br />
<br />
===Date custom field blank===<br />
<pre>if ((ssConvertDate(form.getStr("cf_Project Start Date"), "@dateformat@", "yyyy-mm-dd") == "yyyy-mm-dd")) <br />
{result.isPassed = false;<br />
result.addMsg('cf_@Project Start Date.id@', 'Project Start Date is a required field.');<br />
}</pre><br />
<br />
===Validation on a Select Many Checkbox Field===<br />
<pre>if(form.getStr("cf_Request Type").indexOf("General Operating")==-1 )<br />
{result.isPassed=false;<br />
result.addMsg('General Operating was not selected');<br />
}</pre><br />
To trigger when the value is selected, use '!=-1'. This would normally be used in combination with another field for validations.<br />
<br />
===Select Many Checkbox field has at least 5 values selected===<br />
<pre>if(((form.getStr("cf_Check Box Field").length() - form.getStr("cf_Check Box Field").replace(';','').length())<=4))<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Check Box Field.id@','At least 5 items must be selected.');<br />
}</pre><br />
<br />
===At least one role is selected on a contact===<br />
<pre>if('@rolelist@' == "")<br />
{result.isPassed=false;<br />
result.addMsg('At least one role must be selected.');<br />
}</pre><br />
<br />
===Validation on an e-mail field===<br />
<pre>if(!isEmail(form.getStr("cf_Additional Email 1")))<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Additional Email 1.id@','Please enter a valid e-mail address.');<br />
}</pre><br />
<br />
===Validate that the status of the organization is Active===<br />
<pre>if("@client.status@" != "Active")<br />
{result.isPassed=false;<br />
result.addMsg('Please update your Organization Profile then return to this record and click Submit Application.'); <br />
}</pre><br />
<br />
===Validation on a Note Enabled Multiple-Line custom field===<br />
When validating against a Note Enabled field, within the result.addMsg() alert you will need to include '''h''' in-front of the custom field reference.<br />
<br />
<pre>if(form.getStr("cf_notefield")==""){<br />
result.isPassed= false;<br />
result.addMsg("cf_h@notefield.id@","You must type in a description before submitting for revisions.");<br />
}</pre><br />
<br />
===Minimum word count limit===<br />
Used on multiline text fields to limit the minimum word entry<br />
<br />
<pre>if(form.getStr("cf_Leadership").split(' ').length < 100)<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Leadership.id@','Leadership question must have minimum 100 words'); }</pre><br />
<br />
===Count contacts in a specific role===<br />
Used to ensure at least one contact is attached to the record in a specific role<br />
<br />
<pre>if("@level1.[#(?object=contact::criteria=rolename IN ('Panel Reviewer - Pending','Panel Reviewer - Accepted')::groupfunction=count)~userid~#]@" < "1")<br />
{result.isPassed=false;<br />
result.addMsg("Please assign reviewers in the Panel Reviewer Pending or Panel Reviewer Accepted role."); }</pre><br />
<br />
===Defining VAR Variables===<br />
Using var javascript variables to define values to be evaluated within the SmartCheck Validation.<br />
<br />
<pre>var countWatch="[#(?object=activity::criteria=typename='Watchlist Scan' and statusname='Scan Run')~count(eventid)~#]";<br />
<br />
if(countWatch=="0")<br />
{result.isPassed=false;<br />
result.addMsg('Please run a watchlist scan.');<br />
}</pre><br />
<br />
<br />
==To include other scripts into a SmartCheck script:==<br />
<pre>//@include(AnotherSmartCheckScriptName)@<br />
</pre><br />
<br />
<br />
==See Also==<br />
* [[Submit buttons]]<br />
* [[Status]]<br />
* [[Submit Logic on Save or Save Draft Buttons]]<br />
<br />
<br />
[[Category:Applications]][[Category:Global Settings]][[Category:Validation]][[Category:How]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SmartCheck_Validation&diff=39582SmartCheck Validation2022-03-07T15:53:25Z<p>DEardley: </p>
<hr />
<div>=Overview=<br />
SmartCheck Validation is a secure server side validation method. It enables custom field validation ensuring that applications and form inputs meets specified criteria and returns. It provides a better user experience than other validation methodologies and is preferred over Submit Logic. With SmartCheck, the user can see error messages in context and in one central place.<br />
<br />
Before SmartCheck Validation, some error message would pop up individually, one after another, and some messages would appear in one box at the top, depending on how you setup your validation.<br />
<br />
[[image:Smartcheck validationOLD.png]]<br />
<br />
<br />
With SmartCheck Validation and the message type of '''Field''', you will see all messages in one central spot as well as in context messages. See image below.<br />
<br />
<br />
[[image:Smartcheck validation1.png]]<br />
<br />
Clicking on the '''x''' within the in context error message, such as the description field above, enables you to temporarily hide the message. Clicking the error message at the top will bring the cursor to the field where the error is present (if there is a corresponding input). The context error message will also disappear when you have modified the value within field in question.<br />
<br />
<br />
Before you can use SmartCheck validation you must . . .<br />
<br />
1. Configure SmartCheck Validation<br />
<br />
2. Add SmartCheck Validation to Submit Button<br />
<br />
3. Enable SmartCheck Validation<br />
<br />
Note that once you turn on SmartCheck Validation it is enabled everywhere. If you already set up submit logic or other validation before you turned on SmartCheck validation, you will need to test your validation to ensure it works as expected and or replace it with SmartCheck validation.<br />
<br />
<br />
<br />
=Configure SmartCheck Validation=<br />
SmartCheck Validation can be configured for each object type in the system (i.e. individual [[Entity|UTA Level 1/2/3]], company, user, transaction) and then be attached to a Submit button.<br />
<br />
<br />
1. Each entity will have a SmartCheck Validation link available in the corresponding Settings page. Click on this to begin the process of configuring the SmartCheck validation statements.<br />
<br />
[[Image:SmartCheck1.png|700px]]<br />
<br />
<br />
2. The Smartcheck Validation list view will display. There will be a '''New Validation''' button along the top. Click this.<br />
[[Image:SmartCheckLV.png|800px]]<br />
<br />
3. The SmartCheck validation screen will display, comprised of the following 3 tabs . . .<br />
<br />
* Main<br />
* Code Builder<br />
* Source<br />
<br />
<br />
4. Enter appropriate name and description text into the relevant fields on the Main tab and click Save.<br />
<br />
[[Image:SmartCheck2.png|800px]]<br />
<br />
<br />
5. Navigate to the Code Builder tab to add validation using 2 possible approaches.<br />
<br />
* ''New validation:'' Use the drop-downs at the top of the screen to create new validation. Further details on the options available are provided in the SmartCheck Validation Structure section below.<br />
<br />
[[Image:SmartCheck3.png|800px]]<br />
<br />
<br />
<br />
* ''Existing Submit Logic'': Use the drop-down at the bottom of the screen to select a submit button and any existing validation associated with this button.<br />
<br />
[[Image:SmartCheck4.png|800px]]<br />
<br />
<br />
6. Click on the Insert button under the relevant section. This will take you to the Source tab, and show the updated validation statement.<br />
<br />
[[Image:SmartCheck5.png|800px]]<br />
<br />
<br />
7. Click the Save button to store all changes.<br />
<br />
8. Use the Trial Run at the bottom of the Source tab to check whether there are errors when the validation statements run.<br />
<br />
<br />
<br />
=Add SmartCheck Validation to Submit Button=<br />
Once the validation statements are created you can start to add the logic to [[Submit & Save Buttons|Submit or Save buttons]].<br />
<br />
1. Each entity will have a [Submit & Save Buttons]] link available in the corresponding Settings page. Click on this to begin the process of adding the SmartCheck validation statements to a button.<br />
<br />
[[Image:Submit and save button1.png|700px]]<br />
<br />
<br />
2. The Submit & Save Buttons page is displayed, showing a list of configured buttons. Click on the Edit button for the one you wish to edit.<br />
<br />
<br />
3. Select the SmartCheck Validation option from the corresponding drop-down<br />
<br />
[[Image:SmartCheck6.png|800px]]<br />
<br />
<br />
4. Click Save at the bottom of the page.<br />
<br />
<br />
<br />
=Enable SmartCheck Validation=<br />
# In the top header, click the '''Configuration''' drop down.<br />
# Select '''Global Settings'''.<br />
# On the first tab called System, Check the box beside '''Activate SmartCheck Validation'''.<br />
# Click '''Save'''.<br />
<br />
<br />
<br />
=SmartCheck Update History=<br />
Changes to the SmartCheck logic can be tracked using the Update History feature, which is available against each configured SmartCheck validation.<br />
<br />
[[Image:SmartCheckHistory.png]]<br />
<br />
<br />
If user clicks on the Update History button then are presented with an overview of all changes made to that specific SmartCheck validation, including date and time and the person who made the change.<br />
[[Image:SmartCheckHistory2.png|600px]]<br />
<br />
<br />
Users can also compare versions by checking the box on the left of the list view and then clicking on the Compare button.<br />
[[Image:SmartCheckHistory3.png|500px]]<br />
<br />
<br />
Users will be presented with screen showing differences between the 2 versions.<br />
<br />
[[Image:SmartCheckHistory4.png|600px]]<br />
<br />
=SmartCheck Validation Structure=<br />
Each SmartCheck Validation statement shares the following structure:<br />
<br />
* '''If''' Statement (condition to be tested)<br />
* '''Result''' (assigned result based on the condition)<br />
* '''Message''' (to be displayed when result is false)<br />
<br />
<br />
In the example below:<br />
<br />
<pre>if(ssParseNum(form.getStr("cf_Store Value")) > 5)<br />
{result.isPassed=false;<br />
result.addMsg('Some message here');<br />
}<br />
</pre><br />
<br />
Recognize the If, Result, Message structure:<br />
<br />
<pre>if(ssParseNum(form.getStr("cf_Store Value")) > 5)<br />
</pre><br />
Check '''If''' the contents the of the form value (stored in the custom field named cf_Store_Value) is greater than 5,<br />
<br />
<pre>{result.isPassed=false;<br />
</pre><br />
Assign the value of the '''Result''' to '''"false"''' and print the custom message below.<br />
<br />
<pre>result.addMsg('Some message here');<br />
}<br />
</pre><br />
<br />
=Form Value vs Stored Value=<br />
In the SmartCheck code builder there is a select where you choose between '''Form Value''' and '''Stored Value'''. The '''Form Value'''' is the value someone has entered into his or her application (form), this includes information that has not been saved. The '''Stored Value''' is the value from the server (information that has been saved). By using the '''Form Value''' you can validate based on information that the user has entered into the form even if they have not clicked save on their application.<br />
<br />
<br />
Here is how it looks when you call the Form Value for a standard field:<br />
<br />
<pre>if(form.getStr("sf_Application Name") == "")</pre><br />
<br />
Here is how it looks when you call the Stored Value for the same standard field:<br />
<br />
<pre>if("@Application Name@" == "")</pre><br />
<br />
Notice the stored value calls the field using the variable syntax we learned in the variable processor lesson.<br />
<br />
<br />
<br />
=Field vs System Messages=<br />
In the SmartCheck code builder there is a select where you can choose between '''Field''' and '''System''' Messages. '''Field''' messages appear both at the top of the application and on the field that failed validation, this type is recommended for most validations. '''System''' messages appear only at the top of the application. You might use System messages when your validation compares more than one field, as it may not be obvious which field to highlight with the error message.<br />
<br />
<br />
Here is how it looks when you call a system message:<br />
<br />
<pre>result.addMsg('Your message goes here.'); }</pre><br />
<br />
Here is how it looks when you call a Field message on a custom field:<br />
<br />
<pre>result.addMsg('cf_@field name.id@', 'Your message goes here.); }</pre><br />
<br />
Notice the field name is added before your message, so the system knows where to place the validation message, and the system knows where to bring your cursor should you click the message.<br />
<br />
<br />
<br />
=Configuring Messages for Multilingual Systems=<br />
Messages can also be displayed in different languages based on the user's language of choice within the portal. The langid variable for the language must be included within the syntax to tie the message to a particular language setting.<br />
<br />
<br />
The message below would only be shown for the English language:<br />
<br />
<pre>result.addMsg('Your message goes here.', 1); }</pre><br />
<br />
The langid could also be used for Field messages:<br />
<br />
<pre>result.addMsg('cf_@field name.id@', 'Your message goes here.', 1); }</pre><br />
<br />
And the following is an example with multiple languages:<br />
<br />
<pre>if(((form.getStr("cf_Strategy").length() - form.getStr("cf_Strategy").replace(';','').length())>4))<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Strategy.id@','You can pick up to 4 primary strategies you use.', 1);<br />
result.addMsg('cf_@Strategy.id@','Puedes elegir 4 estrategias principales.', 14);<br />
result.addMsg('cf_@Strategy.id@','Vous pouvez choisir à 4 stratégies primaires', 6);<br />
result.addMsg('cf_@Strategy.id@','Você pode escolher 4 estratégias primárias.', 16);<br />
}<br />
</pre><br />
<br />
'''Important:''' The langid variable cannot be selectively applied to the messages, it must be included in every SmartCheck message within the system.<br />
<br />
=Examples=<br />
===Check an amount is greater than $100,000===<br />
<pre>if(ssParseNum(form.getStr("cf_Amount Requested")) > 100000)<br />
{result.isPassed=false; <br />
result.addMsg('cf_@Amount Requested.id@','Amount Requested cannot exceed $100,000');<br />
}</pre><br />
<br />
===Application Name field blank===<br />
<pre>if(form.getStr("sf_Application Name") == "")<br />
{result.isPassed=false;<br />
result.addMsg('Application name cannot be blank');<br />
}</pre><br />
<br />
===Requested Amount less than X===<br />
<pre>if(ssParseNum(form.getStr("cf_Requested Amount")) < "5000")<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Requested Amount.id@','Field test message');<br />
}</pre><br />
<br />
===Number value greater than 5===<br />
<pre>if(ssParseNum(form.getStr("cf_Store Value")) > 5)<br />
{result.isPassed=false;<br />
result.addMsg('Some message here');<br />
}<br />
</pre><br />
<br />
===Single field upload field has no file===<br />
<pre>if("@Single File Field.filename@" == "")<br />
{result.isPassed=false;<br />
result.addMsg('Please upload a file here');<br />
}<br />
</pre><br />
<br />
===Multi file upload field has no files===<br />
<pre>if(ssParseNum("@level1.MUlti upload.numoffiles@") < 1)<br />
{result.isPassed=false;<br />
result.addMsg('Please upload at least one file');<br />
}</pre><br />
<br />
===Dynamic XML field has no entries===<br />
<pre>if("@xml.fieldname.sectionnodename.rownodename.nodecount@"==0)<br />
{result.isPassed=false;<br />
result.addMsg('xml_@fieldname.id@','At least one entry is required in the XML worksheet.');<br />
}</pre><br />
<br />
===Comparing two custom date fields with separate custom time fields storing 24 hour time===<br />
<pre>if(ssConvertDate(form.getStr("cf_Event Start Date"),"@dateformat@", "yyyy-mm-dd")+' '+form.getStr("cf_Event Start Time") >= ssConvertDate(form.getStr("cf_Event End Date"),"@dateformat@", "yyyy-mm-dd")+' '+form.getStr("cf_Event End Time"))<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Event End Time.id@','End Date must take place after the Start Date');<br />
}</pre><br />
<br />
===Comparing a date custom field to the current date===<br />
<pre>if ((ssConvertDate(form.getStr("cf_Individual Review Start Date"), "@dateformat@", "yyyy-mm-dd") > "@date(currentdate)@")) <br />
{result.isPassed = false; <br />
result.addMsg('cf_@Individual Review Start Date.id@', 'Please enter a date less than or equal to today for the date.');<br />
}<br />
</pre><br />
<br />
===Comparing a date custom field to a date that is six months ago (date must be at least six months ago)===<br />
<pre>if(ssConvertDate(form.getStr("cf_Date"),"@dateformat@", "yyyy-mm-dd") > "<!--@sscalculation(DATE_ADD('@date(currentdate)@', INTERVAL -6 MONTH))-->")<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Date.id@','Date must be at least 6 months prior to today's date');<br />
}</pre><br />
NOTE: When using @sscalculation, you <u>must</u> wrap the syntax in double quotes<br />
<br />
===Ensuring an entered date is at least 3 business days away===<br />
<pre>if(ssConvertDate(form.getStr("cf_Date EOI Revision Deadline"),'@dateformat@','yyyy-mm-dd') < "<!--@sscalculation(SS_FUNC.addbusdays("@date(currentdate)@",3))-->")<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Date EOI Revision Deadline.id@','Date must be at least 3 business days away');<br />
}</pre><br />
NOTE: When using @sscalculation, you <u>must</u> wrap the syntax in double quotes<br />
<br />
===Date custom field blank===<br />
<pre>if ((ssConvertDate(form.getStr("cf_Project Start Date"), "@dateformat@", "yyyy-mm-dd") == "yyyy-mm-dd")) <br />
{result.isPassed = false;<br />
result.addMsg('cf_@Project Start Date.id@', 'Project Start Date is a required field.');<br />
}</pre><br />
<br />
===Validation on a Select Many Checkbox Field===<br />
<pre>if(form.getStr("cf_Request Type").indexOf("General Operating")==-1 )<br />
{result.isPassed=false;<br />
result.addMsg('General Operating was not selected');<br />
}</pre><br />
To trigger when the value is selected, use '!=-1'. This would normally be used in combination with another field for validations.<br />
<br />
===Select Many Checkbox field has at least 5 values selected===<br />
<pre>if(((form.getStr("cf_Check Box Field").length() - form.getStr("cf_Check Box Field").replace(';','').length())<=4))<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Check Box Field.id@','At least 5 items must be selected.');<br />
}</pre><br />
<br />
===At least one role is selected on a contact===<br />
<pre>if('@rolelist@' == "")<br />
{result.isPassed=false;<br />
result.addMsg('At least one role must be selected.');<br />
}</pre><br />
<br />
===Validation on an e-mail field===<br />
<pre>if(!isEmail(form.getStr("cf_Additional Email 1")))<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Additional Email 1.id@','Please enter a valid e-mail address.');<br />
}</pre><br />
<br />
===Validate that the status of the organization is Active===<br />
<pre>if("@client.status@" != "Active")<br />
{result.isPassed=false;<br />
result.addMsg('Please update your Organization Profile then return to this record and click Submit Application.'); <br />
}</pre><br />
<br />
===Validation on a Note Enabled Multiple-Line custom field===<br />
When validating against a Note Enabled field, within the result.addMsg() alert you will need to include '''h''' in-front of the custom field reference.<br />
<br />
<pre>if(form.getStr("cf_notefield")==""){<br />
result.isPassed= false;<br />
result.addMsg("cf_h@notefield.id@","You must type in a description before submitting for revisions.");<br />
}</pre><br />
<br />
===Minimum word count limit===<br />
Used on multiline text fields to limit the minimum word entry<br />
<br />
<pre>if(form.getStr("cf_Leadership").split(' ').length < 100)<br />
{result.isPassed=false;<br />
result.addMsg('cf_@Leadership.id@','Leadership question must have minimum 100 words'); }</pre><br />
<br />
===Count contacts in a specific role===<br />
Used to ensure at least one contact is attached to the record in a specific role<br />
<br />
<pre>if("@level1.[#(?object=contact::criteria=rolename IN ('Panel Reviewer - Pending','Panel Reviewer - Accepted')::groupfunction=count)~userid~#]@" < "1")<br />
{result.isPassed=false;<br />
result.addMsg("Please assign reviewers in the Panel Reviewer Pending or Panel Reviewer Accepted role."); }</pre><br />
<br />
==To include other scripts into a SmartCheck script:==<br />
<pre>//@include(AnotherSmartCheckScriptName)@<br />
</pre><br />
<br />
===Defining VAR Variables===<br />
Using var javascript variables to define values to be evaluated within the SmartCheck Validation.<br />
<br />
<pre>var countWatch="[#(?object=activity::criteria=typename='Watchlist Scan' and statusname='Scan Run')~count(eventid)~#]";<br />
<br />
if(countWatch=="0")<br />
{result.isPassed=false;<br />
result.addMsg('Please run a watchlist scan.');<br />
}</pre><br />
<br />
==See Also==<br />
* [[Submit buttons]]<br />
* [[Status]]<br />
* [[Submit Logic on Save or Save Draft Buttons]]<br />
<br />
<br />
[[Category:Applications]][[Category:Global Settings]][[Category:Validation]][[Category:How]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SSlogic&diff=38368SSlogic2021-04-21T20:28:41Z<p>DEardley: </p>
<hr />
<div>[[Web Page View Field|Web Page View]] fields can use a unique [[SmartSimple]] logic interpreter. Web page logic gives you the ability to display certain content or perform certain actions only when specified conditions are met.<br />
[[SmartSimple]] logic uses the following syntax:<br />
<br />
<pre><br />
<!--@sslogic(CONDITION)--><br />
The content to be displayed when condition is true.<br />
This can be more than one line.<br />
<!--@end--><br />
</pre><br />
<br />
* The content to be displayed (the middle line) can either be in plaintext or in HTML.<br />
* Be sure there are quotes (single or double) around the variable and value. Note: Your choice in the use of quotes depends on the variable's contents. E.g. names containing apostrophes should use double quotes when referencing that variable.<br />
* SSlogic does not support nested logic statements. In other words, you cannot put an sslogic statement within another sslogic statement.<br />
* NOTE: You cannot use sscalculation syntax within an sslogic statement. The sslogic syntax will manage the calculating. It does not require additional syntax prompts.<br />
<br />
<br />
'''Example:'''<br />
<br />
* The following will display a Christmas tree image if the month is December:<br />
<br />
<pre><br />
<!--@sslogic(month(now())=12)--><br />
<img src="images/xmasstree.jpg" alt="" /><br />
<!--@end--><br />
</pre><br />
<br />
* Precede the equal sign with an exclamation point to test for '''Not Equal'''<br />
* The following will display a message for all provinces except Ontario:<br />
<br />
<pre><br />
<!--@sslogic("@province@"!="Ontario")--><br />
You are outside of Ontario<br />
<!--@end--><br />
</pre><br />
<br />
==Else Logic==<br />
* Often, you will want to display one of two texts--one text in the case that a condition is met and another in the case that the condition is not met. This is achieved through the use of an "else" operator.<br />
* The following sample code will display one message if a user is male and another if the user is female:<br />
<br />
<pre><br />
<!--@sslogic(@age@>=18)--><br />
Person is an adult.<br />
<!--@else--><br />
Person is a minor.<br />
<!--@end--><br />
</pre><br />
<br />
* The following will display 2 check boxes. If the gender is male the first check box (Male) will be ticked. If the gender is female the second check box will be ticked:<br />
<br />
<pre><br />
<!--@sslogic(@parent.owner.age@>=18)--><br />
<input checked="checked" type="checkbox" /> Adult<br />
<input type="checkbox" /> Minor<br />
<!--@else--><br />
<input type="checkbox" /> Adult<br />
<input checked="checked" type="checkbox" /> Minor<br />
<!--@end--><br />
</pre><br />
<br />
==Multiple Options ("else if" syntax):==<br />
You can use multiple "else if" operators if there are more than just 2 options:<br />
<br />
<nowiki><!--@sslogic(</nowiki>''condition 1'')-->aaa<br />
<nowiki><!--@else if(</nowiki>''condition 2'')-->bbb <br />
<nowiki><!--@else if(</nowiki>''condition 3'')-->ccc <br />
<nowiki><!--@else-->ddd </nowiki><br />
<nowiki><!--@end--></nowiki></nowiki></nowiki></nowiki><br />
<br />
'''Example:'''<br />
<br />
<pre><!--@sslogic("@possibility@"="Yes")--><br />
This will happen for certain.<br />
<!--@else if("@possibility@"="No")--><br />
This is not happening. <br />
<!--@else if("@possibility@"="Maybe")--><br />
This may or may not happen.<br />
<!--@else--><br />
No-one knows what will happen.<br />
<!--@end--></pre><br />
<br />
<!--per support ticket 17150 - Else if for sslogic --><br />
==Multiple Conditions==<br />
* You can include more than one condition:<br />
<br />
<pre><br />
<!--@sslogic('@year@'='2008' AND ('@month@'='1' OR '@month@'='2'))--><br />
This is only displayed if the year is 2008 and the month is either Jan or Feb.<br />
<!--@end--><br />
</pre><br />
<br />
==Fields Storing Single Quotes or Double Quotes==<br />
* SSlogic can be used to display fields that may have single quotes or double quotes stored within them.<br />
* The escape[] function is used to achieve this:<br />
<br />
<pre><nowiki><!--@sslogic('escape["23456$]'!='')--></nowiki><br />
</pre><br />
<pre><nowiki><!--@sslogic('escape[@Field Name@]'!='')--></nowiki><br />
</pre><br />
* NOTE: You must wrap the function using single quotes<br />
<br />
==Using Object Lists==<br />
* Object [[Web_Page_View_Field_Variables#List|Lists]] can also be used in SSlogic.<br />
<br />
<pre><br />
<!--@sslogic("[#(?object=contact::criteria=rolename='Supervisor'::groupfunction=count)~userid~#]">0)--><br />
There is at least one Supervisor<br />
<!--@else--><br />
There are no Supervisors<br />
<!--@end--><br />
</pre><br />
<br />
==Using With SSattach==<br />
* SSlogic can be used to determine which pdf file is appended to the Web Page View using '''ssattach'''<br />
* The following example will attach ''myfilefooter.pdf'' if the Type/Template is Contract, and ''myotherfilefooter.pdf'' if not:<br />
<br />
<pre><br />
<!--@sslogic("@type@"="Contract")--><br />
<!--@ssattach(after;/files/1234/123/myfilefooter.pdf)--><br />
<!--@else--><br />
<!--@ssattach(after;/files/1234/123/myotherfilefooter.pdf )--><br />
<!--@end--><br />
</pre><br />
:: '''''Note:''' [[ssattach]] can be used without sslogic if you want the same pdf file attached to the Web Page View in all cases.''<br />
==Notes==<br />
* SSlogic can be used in workflow e-mails at Level 1 only.<br />
* In general, double quotes (") should be used to enclose variables rather than single quotes ('). If the content includes an apostrophe (equivalent to a single quote) it will disrupt the processing. Double quotes are less common as content. You may want to add an [[Removing Special Characters|onchange]] to the source field to prevent entry of double quotes.<br />
<br />
==See Also==<br />
* [[Web Page View Field]]<br />
* [[Web Page View Field Variables]]<br />
* [[sscalculation]]<br />
<br />
<br />
[[Category:Custom Fields]][[Category:Variables]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SSlogic&diff=38367SSlogic2021-04-21T20:27:55Z<p>DEardley: </p>
<hr />
<div>[[Web Page View Field|Web Page View]] fields can use a unique [[SmartSimple]] logic interpreter. Web page logic gives you the ability to display certain content or perform certain actions only when specified conditions are met.<br />
[[SmartSimple]] logic uses the following syntax:<br />
<br />
<pre><br />
<!--@sslogic(CONDITION)--><br />
The content to be displayed when condition is true.<br />
This can be more than one line.<br />
<!--@end--><br />
</pre><br />
<br />
* The content to be displayed (the middle line) can either be in plaintext or in HTML.<br />
* Be sure there are quotes (single or double) around the variable and value. Note: Your choice in the use of quotes depends on the variable's contents. E.g. names containing apostrophes should use double quotes when referencing that variable.<br />
* SSlogic does not support nested logic statements. In other words, you cannot put an sslogic statement within another sslogic statement.<br />
* NOTE: You cannot use sscalculation syntax within an sslogic statement. The sslogic syntax will manage the calculating. It does not require additional syntax prompts.<br />
<br />
<br />
'''Example:'''<br />
<br />
* The following will display a Christmas tree image if the month is December:<br />
<br />
<pre><br />
<!--@sslogic(month(now())=12)--><br />
<img src="images/xmasstree.jpg" alt="" /><br />
<!--@end--><br />
</pre><br />
<br />
* Precede the equal sign with an exclamation point to test for '''Not Equal'''<br />
* The following will display a message for all provinces except Ontario:<br />
<br />
<pre><br />
<!--@sslogic("@province@"!="Ontario")--><br />
You are outside of Ontario<br />
<!--@end--><br />
</pre><br />
<br />
==Else Logic==<br />
* Often, you will want to display one of two texts--one text in the case that a condition is met and another in the case that the condition is not met. This is achieved through the use of an "else" operator.<br />
* The following sample code will display one message if a user is male and another if the user is female:<br />
<br />
<pre><br />
<!--@sslogic(@age@>=18)--><br />
Person is an adult.<br />
<!--@else--><br />
Person is a minor.<br />
<!--@end--><br />
</pre><br />
<br />
* The following will display 2 check boxes. If the gender is male the first check box (Male) will be ticked. If the gender is female the second check box will be ticked:<br />
<br />
<pre><br />
<!--@sslogic(@parent.owner.clientage@>=18)--><br />
<input checked="checked" type="checkbox" /> Adult<br />
<input type="checkbox" /> Minor<br />
<!--@else--><br />
<input type="checkbox" /> Adult<br />
<input checked="checked" type="checkbox" /> Minor<br />
<!--@end--><br />
</pre><br />
<br />
==Multiple Options ("else if" syntax):==<br />
You can use multiple "else if" operators if there are more than just 2 options:<br />
<br />
<nowiki><!--@sslogic(</nowiki>''condition 1'')-->aaa<br />
<nowiki><!--@else if(</nowiki>''condition 2'')-->bbb <br />
<nowiki><!--@else if(</nowiki>''condition 3'')-->ccc <br />
<nowiki><!--@else-->ddd </nowiki><br />
<nowiki><!--@end--></nowiki></nowiki></nowiki></nowiki><br />
<br />
'''Example:'''<br />
<br />
<pre><!--@sslogic("@possibility@"="Yes")--><br />
This will happen for certain.<br />
<!--@else if("@possibility@"="No")--><br />
This is not happening. <br />
<!--@else if("@possibility@"="Maybe")--><br />
This may or may not happen.<br />
<!--@else--><br />
No-one knows what will happen.<br />
<!--@end--></pre><br />
<br />
<!--per support ticket 17150 - Else if for sslogic --><br />
==Multiple Conditions==<br />
* You can include more than one condition:<br />
<br />
<pre><br />
<!--@sslogic('@year@'='2008' AND ('@month@'='1' OR '@month@'='2'))--><br />
This is only displayed if the year is 2008 and the month is either Jan or Feb.<br />
<!--@end--><br />
</pre><br />
<br />
==Fields Storing Single Quotes or Double Quotes==<br />
* SSlogic can be used to display fields that may have single quotes or double quotes stored within them.<br />
* The escape[] function is used to achieve this:<br />
<br />
<pre><nowiki><!--@sslogic('escape["23456$]'!='')--></nowiki><br />
</pre><br />
<pre><nowiki><!--@sslogic('escape[@Field Name@]'!='')--></nowiki><br />
</pre><br />
* NOTE: You must wrap the function using single quotes<br />
<br />
==Using Object Lists==<br />
* Object [[Web_Page_View_Field_Variables#List|Lists]] can also be used in SSlogic.<br />
<br />
<pre><br />
<!--@sslogic("[#(?object=contact::criteria=rolename='Supervisor'::groupfunction=count)~userid~#]">0)--><br />
There is at least one Supervisor<br />
<!--@else--><br />
There are no Supervisors<br />
<!--@end--><br />
</pre><br />
<br />
==Using With SSattach==<br />
* SSlogic can be used to determine which pdf file is appended to the Web Page View using '''ssattach'''<br />
* The following example will attach ''myfilefooter.pdf'' if the Type/Template is Contract, and ''myotherfilefooter.pdf'' if not:<br />
<br />
<pre><br />
<!--@sslogic("@type@"="Contract")--><br />
<!--@ssattach(after;/files/1234/123/myfilefooter.pdf)--><br />
<!--@else--><br />
<!--@ssattach(after;/files/1234/123/myotherfilefooter.pdf )--><br />
<!--@end--><br />
</pre><br />
:: '''''Note:''' [[ssattach]] can be used without sslogic if you want the same pdf file attached to the Web Page View in all cases.''<br />
==Notes==<br />
* SSlogic can be used in workflow e-mails at Level 1 only.<br />
* In general, double quotes (") should be used to enclose variables rather than single quotes ('). If the content includes an apostrophe (equivalent to a single quote) it will disrupt the processing. Double quotes are less common as content. You may want to add an [[Removing Special Characters|onchange]] to the source field to prevent entry of double quotes.<br />
<br />
==See Also==<br />
* [[Web Page View Field]]<br />
* [[Web Page View Field Variables]]<br />
* [[sscalculation]]<br />
<br />
<br />
[[Category:Custom Fields]][[Category:Variables]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=DocuSign&diff=38186DocuSign2021-01-11T20:36:15Z<p>DEardley: /* DocuSign Tags */</p>
<hr />
<div>==Configuring Global Settings==<br />
1. Go to Global Settings - Integrations - Integration Key Management. <br /><br />
2. Click on '''New Integration Key'''. You will be presented with the following fields:<br />
<br />
* Key Type: set to DocuSign<br />
* Integrator Key**:<br />
* Secret Key**: unique secret code for the client (see below for a description of where these are found)<br />
<br />
3. Back in SmartSimple, Click '''Save''' once both keys have been entered.<br /><br />
4. On the Integrations tab, look for the '''Online Signature Provider''' section, and select '''DocuSign'''. You will then need to click the button labeled "Activate DocuSign Access", and enter your '''DocuSign''' login credentials. Once you've saved, the text next to the button should read: '''DocuSign Access: Enabled'''.<br /><br />
5. Configure your Web Page View field and use the tags outlined below to incorporate '''DocuSign''' functions with your SmartSimple data. Make sure these two field options are enabled:<br />
<br />
* Online Signature: This will enable a new button in the Web Page View called "Online Signature".<br />
* Enable Save to Server: This will allow a copy of the signed PDF document to be saved within SmartSimple.<br />
* You can also create an Upload field, if desired, in which to store the signed PDF file. Use the Store-To Value option in the Web Page View field to point to this additional field.<br />
<br />
6. Make sure you've created a role for your Signees, and that the intended person is added as a Contact using this role. Your Web Page View field will need to contain list syntax that specifies the roleid; this is how SmartSimple knows to whom the e-signature request should be sent.<br />
<br />
<pre>* for Integrator Key and Secret Keys, login to your DocuSign account, click on the "User" icon - go to Admin-->Integrations-->API and Keys (on left menu) - click on the Integrator Key and there you will be able to add new Secret keys.</pre><br />
<br />
Tip: Within the Web Page View window, you can click the Online Signature button to view the status of the current request once it's been sent.<br />
<br />
==DocuSign Account Set Up==<br />
To use DocuSign as a signature provider in SmartSimple, you will need to sign up with DocuSign for an account with API capabilities. DocuSign requires users to create a sandbox account (reference: [https://www.docusign.com/blog/dsdev-new-api-and-keys-page/ https://www.docusign.com/blog/dsdev-new-api-and-keys-page/]) in order to create an integration key for their DocuSign API integration. After you obtained an integration key from your DocuSign sandbox account, to complete the set up process, you will have to provide the Redirect URIs (see screenshots for additional information on the instructions) for the DocuSign - SmartSimple integration.<br />
<br />
For the Redirect URIs:<br />
<br />
1. Go to Global Settings - Integrations - Integration Key Management. <br />
<br />
2. Click on '''New Integration Key'''. You will be presented with the following fields:<br />
<br />
* Key Type: set to DocuSign<br />
* Key name: set to DocuSign<br />
<br />
3. Copy the '''Redirect URL'''<br />
<br />
4. Use this URL for the DocuSiign API account (when you are on DocuSign site to sign up for an API account)<br />
<br />
[[File:Fromdocusign.png|800px]]<br />
<br />
[[File:docusignURL1.png|800px]]<br />
<br />
[[File:docusignURL2.png|800px]]<br />
<br />
[[File:docusignURL3.png|800px]]<br />
<br />
==DocuSign Tags==<br />
Use the below tags to configure the contact details and signing order for the signees.<br />
<br />
{| class="wikitable"<br />
|-<br />
||'''Function'''<br />
||'''Tag Format'''<br />
||'''Example'''<br />
||'''Notes'''<br />
|-<br />
||Populate the email subject<br />
||<br />
<pre><!--SignatureEmailSubject Place Subject Here--></pre><br />
||<br />
<pre><!--SignatureEmailSubject @name@ Test Email Subject--></pre><br />
||Include a variable here, such as the L1 name.<br />
|-<br />
||Populate the email body<br />
||<br />
<pre><!--SignatureEmailBody Place body text here.--></pre><br />
||<br />
<pre><!--SignatureEmailBody This is a test.--></pre><br />
||<br />
|-<br />
||Configure the DocuSign expiration date<br />
||<br />
<pre><!--SignatureExpiryDays Insert Numeric Value--></pre><br />
||<br />
<pre><!--SignatureExpiryDays 14--></pre><br />
||After submission to Docusign, the document will expire after 14 days. Signees will not be able to access the document if it has gone unsigned at the time of expiry.<br />
|-<br />
||Configure the CC email list<br />
||<br />
<pre><!--SignatureCC email;Name,email2;Name2--></pre><br />
||<br />
<pre><!--SignatureCC abc@fake.com;ABC Smith,qa1@fake.com;QA1--></pre><br />
||Emails will be copied to the list of people included here.<br />
|-<br />
||Configure the email language<br />
||<br />
<pre><!--SignatureLocale Language Code--></pre><br />
||<br />
<pre><!--SignatureLocale en--></pre><br />
||Sets the email language, such as en, fr, etc.<br />
|-<br />
||Configure the email flow for multiple signees<br />
||<br />
<pre><!--SignatureFlow Indicator--></pre><br />
||<br />
<pre><!--SignatureFlow P--></pre><br />
||If you specify the signature flow as P (Parallel), emails will be sent to all signees at the same time.<br />
If you specify the signature flow as S (Sequential), emails will be sent sequentially, for example: email will only be sent to the second signee after the first signee has completed signing the document, and so on.<br />
|-<br />
||Set the Signature Block location<br />
||<br />
<pre><!--SignatureBlock Anchor String--></pre><br />
||<br />
<pre><!--SignatureBlock Anchor String--></pre><br />
||If you wish to have the Signature Block appear in the document in a fixed position then you must include SignatureBlock tag with anchor string defined and then, in the document itself, have a text string that matches the anchor string.<br />
* If the anchor string is "Please sign", DocuSign will find "Please sign" in your HTML and place the Signature block below it. Signees will see a signature block to click on and sign.<br />
* If you have 2 signees, then the 2nd signee's signature block will be placed 1 inch below the 1st signee's signature block.<br />
* If anchor string text is not found in the document, or if you do not include the SignatureBlock tag in your HTML, signees will have the option to place their signature anywhere in the document.<br />
<br />
|-<br />
||Date Signed<br />
||<br />
<pre><!--DateBlock AnchorString--></pre><br />
||<br />
<pre><!--DateBlock Signed On: --></pre><br />
||Here the anchor string is "Signed On: "<br />
DocuSign will find "Signed On: " in your HTML and place the Date of the signature beside it.<br />
|-<br />
||Set the location of the Initials Block<br />
||<br />
<pre><!--InitialsBlock InitialsAnchorString--></pre><br />
||<br />
<pre><!--InitialsBlock Your Initials:--></pre><br />
||Here the anchor string is "Your Initials: "<br />
DocuSign will find "Your Initials: " in your HTML and place the Initials Block below it. If the specified AnchorString is not found in the document, or if you do not include this tag in your HTML, signees will have the option to place their initials anywhere in the document.<br />
||<br />
|}<br />
<br />
==Note==<br />
For DocuSign to retrieve signee emails, names etc, you will have to embed them in your HTML. They will then be used in the email sent to signees. For example:<br />
<br />
<pre> [#(?object=contact;criteria=roleid='12527';orderby=firstname) <!--SignatureFlow P--><!--signature ~email~;SIGNER;~firstname~;~lastname~;~Index~;~companyname~-->#]</pre><br />
<br />
If you have 3 signees assigned to the Level 1, the HTML in your Web Page View will be embedded with the info for all three:<br />
<br />
<pre><br />
<!--signature ttest@smartsimple.com;SIGNER;Tony;Test;1;SmartSimple Software --><br />
<!--signature fake@smartsimple.com;SIGNER;Fake;Man;2;Fake Co. --><br />
<!--signature fake2@smartsimple.com;SIGNER;Fake2;Mann;3;Fake2 Co. --><br />
</pre><br />
<br />
[[Category:Integration]]<br />
[[Category:External Services]]<br />
[[Category: e-Signature]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=DocuSign&diff=38181DocuSign2021-01-11T20:30:01Z<p>DEardley: /* DocuSign Tags */</p>
<hr />
<div>==Configuring Global Settings==<br />
1. Go to Global Settings - Integrations - Integration Key Management. <br /><br />
2. Click on '''New Integration Key'''. You will be presented with the following fields:<br />
<br />
* Key Type: set to DocuSign<br />
* Integrator Key**:<br />
* Secret Key**: unique secret code for the client (see below for a description of where these are found)<br />
<br />
3. Back in SmartSimple, Click '''Save''' once both keys have been entered.<br /><br />
4. On the Integrations tab, look for the '''Online Signature Provider''' section, and select '''DocuSign'''. You will then need to click the button labeled "Activate DocuSign Access", and enter your '''DocuSign''' login credentials. Once you've saved, the text next to the button should read: '''DocuSign Access: Enabled'''.<br /><br />
5. Configure your Web Page View field and use the tags outlined below to incorporate '''DocuSign''' functions with your SmartSimple data. Make sure these two field options are enabled:<br />
<br />
* Online Signature: This will enable a new button in the Web Page View called "Online Signature".<br />
* Enable Save to Server: This will allow a copy of the signed PDF document to be saved within SmartSimple.<br />
* You can also create an Upload field, if desired, in which to store the signed PDF file. Use the Store-To Value option in the Web Page View field to point to this additional field.<br />
<br />
6. Make sure you've created a role for your Signees, and that the intended person is added as a Contact using this role. Your Web Page View field will need to contain list syntax that specifies the roleid; this is how SmartSimple knows to whom the e-signature request should be sent.<br />
<br />
<pre>* for Integrator Key and Secret Keys, login to your DocuSign account, click on the "User" icon - go to Admin-->Integrations-->API and Keys (on left menu) - click on the Integrator Key and there you will be able to add new Secret keys.</pre><br />
<br />
Tip: Within the Web Page View window, you can click the Online Signature button to view the status of the current request once it's been sent.<br />
<br />
==DocuSign Account Set Up==<br />
To use DocuSign as a signature provider in SmartSimple, you will need to sign up with DocuSign for an account with API capabilities. DocuSign requires users to create a sandbox account (reference: [https://www.docusign.com/blog/dsdev-new-api-and-keys-page/ https://www.docusign.com/blog/dsdev-new-api-and-keys-page/]) in order to create an integration key for their DocuSign API integration. After you obtained an integration key from your DocuSign sandbox account, to complete the set up process, you will have to provide the Redirect URIs (see screenshots for additional information on the instructions) for the DocuSign - SmartSimple integration.<br />
<br />
For the Redirect URIs:<br />
<br />
1. Go to Global Settings - Integrations - Integration Key Management. <br />
<br />
2. Click on '''New Integration Key'''. You will be presented with the following fields:<br />
<br />
* Key Type: set to DocuSign<br />
* Key name: set to DocuSign<br />
<br />
3. Copy the '''Redirect URL'''<br />
<br />
4. Use this URL for the DocuSiign API account (when you are on DocuSign site to sign up for an API account)<br />
<br />
[[File:Fromdocusign.png|800px]]<br />
<br />
[[File:docusignURL1.png|800px]]<br />
<br />
[[File:docusignURL2.png|800px]]<br />
<br />
[[File:docusignURL3.png|800px]]<br />
<br />
==DocuSign Tags==<br />
Use the below tags to configure the contact details and signing order for the signees.<br />
<br />
{| class="wikitable"<br />
|-<br />
||'''Function'''<br />
||'''Tag Format'''<br />
||'''Example'''<br />
||'''Notes'''<br />
|-<br />
||Populate the email subject<br />
||<br />
<pre><!--SignatureEmailSubject Place Subject Here--></pre><br />
||<br />
<pre><!--SignatureEmailSubject @name@ Test Email Subject--></pre><br />
||Include a variable here, such as the L1 name.<br />
|-<br />
||Populate the email body<br />
||<br />
<pre><!--SignatureEmailBody Place body text here.--></pre><br />
||<br />
<pre><!--SignatureEmailBody This is a test.--></pre><br />
||<br />
|-<br />
||Configure the DocuSign expiration date<br />
||<br />
<pre><!--SignatureExpiryDays Insert Numeric Value--></pre><br />
||<br />
<pre><!--SignatureExpiryDays 14--></pre><br />
||After submission to Docusign, the document will expire after 14 days. Signees will not be able to access the document if it has gone unsigned at the time of expiry.<br />
|-<br />
||Configure the CC email list<br />
||<br />
<pre><!--SignatureCC email;Name,email2;Name2--></pre><br />
||<br />
<pre><!--SignatureCC abc@fake.com;ABC Smith,qa1@fake.com;QA1--></pre><br />
||Emails will be copied to the list of people included here.<br />
|-<br />
||Configure the email language<br />
||<br />
<pre><!--SignatureLocale Language Code--></pre><br />
||<br />
<pre><!--SignatureLocale en--></pre><br />
||Sets the email language, such as en, fr, etc.<br />
|-<br />
||Configure the email flow for multiple signees<br />
||<br />
<pre><!--SignatureFlow Indicator--></pre><br />
||<br />
<pre><!--SignatureFlow P--></pre><br />
||If you specify the signature flow as P (Parallel), emails will be sent to all signees at the same time.<br />
If you specify the signature flow as S (Sequential), emails will be sent sequentially, for example: email will only be sent to the second signee after the first signee has completed signing the document, and so on.<br />
|-<br />
||Set the Signature Block location<br />
||<br />
<pre><!--SignatureBlock Anchor String--></pre><br />
||<br />
<pre><!--SignatureBlock Anchor String--></pre><br />
||If you wish to have the Signature Block appear in the document in a fixed position then you must include SignatureBlock tag with anchor string defined and then, in the document itself, have a text string that matches the anchor string.<br />
* If the anchor string is "Please sign", DocuSign will find "Please sign" in your HTML and place the Signature block below it. Signees will see a signature block to click on and sign.<br />
* If you have 2 signees, then the 2nd signee's signature block will be placed 1 inch below the 1st signee's signature block.<br />
* If anchor string text is not found in the document, or if you do not include the SignatureBlock tag in your HTML, signees will have the option to place their signature anywhere in the document.<br />
|-<br />
||Date of Signing<br />
||<br />
<pre><!--DateBlock Signed On: --></pre><br />
||<br />
<pre><!--SignatureLocale en--></pre><br />
||Sets the email language, such as en, fr, etc.<br />
|-<br />
||Set the location of the Initials Block<br />
||<br />
<pre><!--InitialsBlock InitialsAnchorString--></pre><br />
||<br />
<pre><!--InitialsBlock Your Initials:--></pre><br />
||Here the anchor string is "Your Initials: "<br />
DocuSign will find "Your Initials: " in your HTML and place the Initials Block below it. If the specified AnchorString is not found in the document, or if you do not include this tag in your HTML, signees will have the option to place their initials anywhere in the document.<br />
|-<br />
||Set the location of the Date Signed<br />
||<br />
<pre><!--DateBlock Signed On: --></pre><br />
||Here the anchor string is "Signed On: "<br />
DocuSign will find "Signed On: " in your HTML and place the Date Signed below it.<br />
<br />
||<br />
|}<br />
<br />
==Note==<br />
For DocuSign to retrieve signee emails, names etc, you will have to embed them in your HTML. They will then be used in the email sent to signees. For example:<br />
<br />
<pre> [#(?object=contact;criteria=roleid='12527';orderby=firstname) <!--SignatureFlow P--><!--signature ~email~;SIGNER;~firstname~;~lastname~;~Index~;~companyname~-->#]</pre><br />
<br />
If you have 3 signees assigned to the Level 1, the HTML in your Web Page View will be embedded with the info for all three:<br />
<br />
<pre><br />
<!--signature ttest@smartsimple.com;SIGNER;Tony;Test;1;SmartSimple Software --><br />
<!--signature fake@smartsimple.com;SIGNER;Fake;Man;2;Fake Co. --><br />
<!--signature fake2@smartsimple.com;SIGNER;Fake2;Mann;3;Fake2 Co. --><br />
</pre><br />
<br />
[[Category:Integration]]<br />
[[Category:External Services]]<br />
[[Category: e-Signature]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=DocuSign&diff=38179DocuSign2021-01-11T20:29:02Z<p>DEardley: /* DocuSign Tags */</p>
<hr />
<div>==Configuring Global Settings==<br />
1. Go to Global Settings - Integrations - Integration Key Management. <br /><br />
2. Click on '''New Integration Key'''. You will be presented with the following fields:<br />
<br />
* Key Type: set to DocuSign<br />
* Integrator Key**:<br />
* Secret Key**: unique secret code for the client (see below for a description of where these are found)<br />
<br />
3. Back in SmartSimple, Click '''Save''' once both keys have been entered.<br /><br />
4. On the Integrations tab, look for the '''Online Signature Provider''' section, and select '''DocuSign'''. You will then need to click the button labeled "Activate DocuSign Access", and enter your '''DocuSign''' login credentials. Once you've saved, the text next to the button should read: '''DocuSign Access: Enabled'''.<br /><br />
5. Configure your Web Page View field and use the tags outlined below to incorporate '''DocuSign''' functions with your SmartSimple data. Make sure these two field options are enabled:<br />
<br />
* Online Signature: This will enable a new button in the Web Page View called "Online Signature".<br />
* Enable Save to Server: This will allow a copy of the signed PDF document to be saved within SmartSimple.<br />
* You can also create an Upload field, if desired, in which to store the signed PDF file. Use the Store-To Value option in the Web Page View field to point to this additional field.<br />
<br />
6. Make sure you've created a role for your Signees, and that the intended person is added as a Contact using this role. Your Web Page View field will need to contain list syntax that specifies the roleid; this is how SmartSimple knows to whom the e-signature request should be sent.<br />
<br />
<pre>* for Integrator Key and Secret Keys, login to your DocuSign account, click on the "User" icon - go to Admin-->Integrations-->API and Keys (on left menu) - click on the Integrator Key and there you will be able to add new Secret keys.</pre><br />
<br />
Tip: Within the Web Page View window, you can click the Online Signature button to view the status of the current request once it's been sent.<br />
<br />
==DocuSign Account Set Up==<br />
To use DocuSign as a signature provider in SmartSimple, you will need to sign up with DocuSign for an account with API capabilities. DocuSign requires users to create a sandbox account (reference: [https://www.docusign.com/blog/dsdev-new-api-and-keys-page/ https://www.docusign.com/blog/dsdev-new-api-and-keys-page/]) in order to create an integration key for their DocuSign API integration. After you obtained an integration key from your DocuSign sandbox account, to complete the set up process, you will have to provide the Redirect URIs (see screenshots for additional information on the instructions) for the DocuSign - SmartSimple integration.<br />
<br />
For the Redirect URIs:<br />
<br />
1. Go to Global Settings - Integrations - Integration Key Management. <br />
<br />
2. Click on '''New Integration Key'''. You will be presented with the following fields:<br />
<br />
* Key Type: set to DocuSign<br />
* Key name: set to DocuSign<br />
<br />
3. Copy the '''Redirect URL'''<br />
<br />
4. Use this URL for the DocuSiign API account (when you are on DocuSign site to sign up for an API account)<br />
<br />
[[File:Fromdocusign.png|800px]]<br />
<br />
[[File:docusignURL1.png|800px]]<br />
<br />
[[File:docusignURL2.png|800px]]<br />
<br />
[[File:docusignURL3.png|800px]]<br />
<br />
==DocuSign Tags==<br />
Use the below tags to configure the contact details and signing order for the signees.<br />
<br />
{| class="wikitable"<br />
|-<br />
||'''Function'''<br />
||'''Tag Format'''<br />
||'''Example'''<br />
||'''Notes'''<br />
|-<br />
||Populate the email subject<br />
||<br />
<pre><!--SignatureEmailSubject Place Subject Here--></pre><br />
||<br />
<pre><!--SignatureEmailSubject @name@ Test Email Subject--></pre><br />
||Include a variable here, such as the L1 name.<br />
|-<br />
||Populate the email body<br />
||<br />
<pre><!--SignatureEmailBody Place body text here.--></pre><br />
||<br />
<pre><!--SignatureEmailBody This is a test.--></pre><br />
||<br />
|-<br />
||Configure the DocuSign expiration date<br />
||<br />
<pre><!--SignatureExpiryDays Insert Numeric Value--></pre><br />
||<br />
<pre><!--SignatureExpiryDays 14--></pre><br />
||After submission to Docusign, the document will expire after 14 days. Signees will not be able to access the document if it has gone unsigned at the time of expiry.<br />
|-<br />
||Configure the CC email list<br />
||<br />
<pre><!--SignatureCC email;Name,email2;Name2--></pre><br />
||<br />
<pre><!--SignatureCC abc@fake.com;ABC Smith,qa1@fake.com;QA1--></pre><br />
||Emails will be copied to the list of people included here.<br />
|-<br />
||Configure the email language<br />
||<br />
<pre><!--SignatureLocale Language Code--></pre><br />
||<br />
<pre><!--SignatureLocale en--></pre><br />
||Sets the email language, such as en, fr, etc.<br />
|-<br />
||Configure the email flow for multiple signees<br />
||<br />
<pre><!--SignatureFlow Indicator--></pre><br />
||<br />
<pre><!--SignatureFlow P--></pre><br />
||If you specify the signature flow as P (Parallel), emails will be sent to all signees at the same time.<br />
If you specify the signature flow as S (Sequential), emails will be sent sequentially, for example: email will only be sent to the second signee after the first signee has completed signing the document, and so on.<br />
|-<br />
||Set the Signature Block location<br />
||<br />
<pre><!--SignatureBlock Anchor String--></pre><br />
||<br />
<pre><!--SignatureBlock Anchor String--></pre><br />
||If you wish to have the Signature Block appear in the document in a fixed position then you must include SignatureBlock tag with anchor string defined and then, in the document itself, have a text string that matches the anchor string.<br />
* If the anchor string is "Please sign", DocuSign will find "Please sign" in your HTML and place the Signature block below it. Signees will see a signature block to click on and sign.<br />
* If you have 2 signees, then the 2nd signee's signature block will be placed 1 inch below the 1st signee's signature block.<br />
* If anchor string text is not found in the document, or if you do not include the SignatureBlock tag in your HTML, signees will have the option to place their signature anywhere in the document.<br />
<br />
|-<br />
||Set the location of the Initials Block<br />
||<br />
<pre><!--InitialsBlock InitialsAnchorString--></pre><br />
||<br />
<pre><!--InitialsBlock Your Initials:--></pre><br />
||Here the anchor string is "Your Initials: "<br />
DocuSign will find "Your Initials: " in your HTML and place the Initials Block below it. If the specified AnchorString is not found in the document, or if you do not include this tag in your HTML, signees will have the option to place their initials anywhere in the document.<br />
<br />
||<br />
<pre><!--DateBlock Signed On: --></pre><br />
||Here the anchor string is "Signed On: "<br />
DocuSign will find "Signed On: " in your HTML and place the Date Signed below it. <br />
||<br />
|}<br />
<br />
==Note==<br />
For DocuSign to retrieve signee emails, names etc, you will have to embed them in your HTML. They will then be used in the email sent to signees. For example:<br />
<br />
<pre> [#(?object=contact;criteria=roleid='12527';orderby=firstname) <!--SignatureFlow P--><!--signature ~email~;SIGNER;~firstname~;~lastname~;~Index~;~companyname~-->#]</pre><br />
<br />
If you have 3 signees assigned to the Level 1, the HTML in your Web Page View will be embedded with the info for all three:<br />
<br />
<pre><br />
<!--signature ttest@smartsimple.com;SIGNER;Tony;Test;1;SmartSimple Software --><br />
<!--signature fake@smartsimple.com;SIGNER;Fake;Man;2;Fake Co. --><br />
<!--signature fake2@smartsimple.com;SIGNER;Fake2;Mann;3;Fake2 Co. --><br />
</pre><br />
<br />
[[Category:Integration]]<br />
[[Category:External Services]]<br />
[[Category: e-Signature]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Template:November2020Upgrade&diff=38128Template:November2020Upgrade2020-11-05T14:23:23Z<p>DEardley: /* New Display Options for Portal Shortcuts */</p>
<hr />
<div>==General Details==<br />
===Upgrade Dates===<br />
Public Cloud Production release date: '''November 12th 2020'''<br /><br />
Public Cloud Backup release date: '''October 27th 2020'''<br />
<br />
Private Cloud Production (Managed Upgrades) release date: '''November 26th 2020'''<br /><br />
Private Cloud Backup (Managed Upgrades) release date: '''November 12th 2020'''<br />
<br />
==Overview==<br />
Watch this video to get a general overview of the new features in this release.<br />
<br />
<!--{{#ev:youtube|b-p5Z4K7m34}}--><br />
<br />
''To watch this video in full screen, please click on the '''full screen''' button on the bottom right.''<br />
<br />
==Global System Upgrades==<br />
The new features listed below are enhancements to the SmartSimple system and will be immediately available to SmartSimple users upon the application of the upgrade to their server:<br />
<br />
===Major Updates===<br />
<br />
====Deprecation of Google Drive Integration====<br />
Deprecated the option to enable Google Drive lookups when uploading to a file upload area. The '''Global Settings''' option '''Enable Google Drive Lookup''' for File Fields will be automatically disabled and then deprecated with this upgrade.<br />
<!--116829 - deprecate google drive integration--><br />
<br />
====Enhanced Geomapping Functions for List Views====<br />
Enhanced geomapping functionality for list views. Please note that these changes will be reflected in currently existing list views that have the map panel option enabled. The default size of the map has been slightly reduced, but can be enlarged to fit the screen. The search functions that were previously embedded within the map have been moved out next to the regular list view search panel for the added convenience of being able to combine both search functions now. Proximity searching is now enabled by default for any list view that has enabled the map panel functionality. This allows users to filter records based on both custom search criteria, as well as proximity-based searching. The geographical locations to be used for the distance calculations are variable and can be specified to be the owner of a UTA Level 1 record, or the associated organization, or even a UTA Level 2 address record of the Level 1. The look and feel, and interactions between the list view records and the map panel have also been improved for a more intuitive interaction.<br />
<!--97127 - proximity list view phase 2 ( map ) geocoding--><br />
<br />
[[File:2020-11-ticket-97127-1.png|thumb|none|800px|The new look of the enhanced map with proximity search.]]<br />
<br />
====Extended Inline Media Playback Functionality for User Portal====<br />
Enhanced media playback support to allow for playback of media inline within a user portal. Previously, inline media playback was only available while viewing a record, otherwise the media player would open up in a modal window. This change allows users to more easily navigate a portal while playing some media content.<br />
<!--84220 - Play video inline inside media library portal sections--><br />
<br />
[[File:2020-11-ticket-84220-1.png|thumb|none|800px|Portal videos can be played inline and optionally opened in fullscreen without opening a modal window.]]<br />
<br />
===Minor Updates===<br />
<br />
====Minor Update to Visual Style of Instruction Text====<br />
Minor update to the visual styling of instruction text throughout the system to make these areas a bit more prominent and consistent throughout.<br />
<!--110107 - Update form instructions style to reflect the platform instruction design styles--><br />
<br />
[[File:2020-11-ticket-110107-1.png|thumb|none|800px|Pre-upgrade look of custom and standard field instructions set to caption above.]]<br />
[[File:2020-11-ticket-110107-2.png|thumb|none|800px|Post-upgrade look of custom and standard field instructions set to caption above.]]<br />
<br />
====Minor Update to Button Style====<br />
Minor visual changes were made to the '''Back''' button, which will now appear with less opacity when you first log in with no session history. In addition, the '''Previous''' and '''Next''' buttons found on list views will also have less opacity when you are on the first or last page on the list.<br />
<!--111032 - Change button visual when not clickable--><br />
<br />
[[File:2020-11-ticket-111032-1.png|thumb|none|800px|Buttons will display with less opacity when you cannot interact with them.]]<br />
<br />
====New Global Session Timeout Enforced====<br />
New absolute session limit introduced to enforce termination of a login session after 24 hours. There is now a maximum limit of 24 hours for any single login session, whereby any session longer than 24 hours will be automatically terminated no matter your individual instance setting for Session Timeout, which we recommend much shorter than 24 hours!<br />
<!--114732 - Absolute session timeout--><br />
<br />
====Added Options for Notification Broadcasts====<br />
Enhanced the '''Notification Broadcast''' feature with more granular features for targeting users and customization of message icon. A new option has been added for restricting messages from being sent to users in specified user roles. Also, notification messages were previously all displayed with a wrench icon indicating a system or maintenance message. As we've seen more expanded and creative use of these notification messages, you can now choose different icons for them to better indicate the type of message that is being delivered.<br />
<!--86840 - Notification broadcast icon and type--><br />
<!--87150 - Deny Role for Notification Broadcasts--><br />
<br />
[[File:2020-11-ticket-86840-1.png|thumb|none|800px|Choose icons for your notification broadcasts to better indicate the type of message being delivered (Notification icon view).]]<br />
[[File:2020-11-ticket-86840-2.png|thumb|none|800px|Choose icons for your notification broadcasts to better indicate the type of message being delivered (Notification modal view).]]<br />
<br />
==On-Demand System Upgrades==<br />
The following features are available immediately with the application of the upgrade, but must first be enabled or configured by a '''Global Administrator''':<br />
<br />
===Major Updates===<br />
====New Banner Section Type Available for Portal Configuration====<br />
New '''Banner''' section type available for portal configuration to easily configure banner areas in your portal. This allows you to very quickly and easily create great looking banner sections within your user portals. There are 4 layouts to choose from that will affect the alignment of text and link buttons. These banner sections can display a background image, some informational text, and configurable buttons or links to other areas of the system.<br />
<!--113631 - more website theme templates for portals--><br />
<br />
[[File:2020-11-ticket-113631-1.jpg|thumb|none|800px|New section type called "Banner" available in portals.]]<br />
<br />
====New IRS Verification Integration with Charity Navigator Available====<br />
New integration with Charity Navigator available for IRS status verification of organizations. This is a new vendor integration that applies to the same areas as the existing IRS status verification service. Specifically this integration can be configured within organization sign up pages for verification at registration, or within transaction types for on-going verification of organizations. The benefit of this latest integration is that it will verify the IRS status of an organization real-time, as opposed to the previous integration service that would refresh its data source only once per month. Also, this new Charity Navigator source will contain additional organizations that were not present in the previous data source, such as organizations with 501(c)(3) status but who don't have an EIN number.<br />
<!--115767 - Charity Navigation IRS Search Phase 2--><br />
<br />
====Added Permission Setting for Manual Password Updates====<br />
Added setting to allow specified user roles the ability to manually set a password for other users. Previously, this ability was limited to '''Global Administrator''' users but you can now set which users can do this similar to the send password functionality. You can find this setting within the '''Permissions''' tab of the user roles configuration screen.<br />
<!--111731 - Set Password Option for certain roles--><br />
<br />
====Enhanced Duplicate Check Configuration on Sign Up Pages to Allow Multiple Criteria====<br />
Enhanced the duplicate check functionality for sign up pages. You can now specify multiple sets of criteria to validate a new sign up record against existing records to block duplicate entry. Previously, the duplicate check function was limited to the definition of only a single set of criteria where every field needed to match an existing record in order to constitute a duplicate match. You may now configure multiple definitions for the detection of a duplicate record.<br />
<!--107203 - Signup page duplicate check--><br />
<br />
====New Custom Field Type Display - Countdown Timer====<br />
New custom field type '''Display - Countdown Timer''' available. This field will display a visual countdown on the user's screen as the time nears the date/time in a defined date/time field. This field can be configured to display a custom message during this countdown, as well as after the countdown has been completed. This field can be used to warn users of immediate deadlines approaching, and improve submission rates at time of deadline.<br />
<!--73341 -Timer on ActionDate--><br />
<br />
[[File:2020-11-ticket-73341-1.png|thumb|none|800px|New custom field type called "Display - Countdown Timer" with some added custom styling.]]<br />
<br />
====Added Option to Limit Availability of Provider/Consumer Lists====<br />
Enhanced Provider/Consumer list views with additional configuration options to limit the availability of consumer list views to specific provider types. You can now restrict the availability and thus visibility of a consumer list view to a set of provider type records. This allows you more granular control and improved user experience in working with associations of records between different UTAs.<br />
<!--107191 - Type Permission on Consumer/Provider List Views--><br />
<br />
====Extended Special - Linked Record List Custom Field Type to Organizations and Users====<br />
Extended the '''Special - Linked Record List''' custom field type to be available for Organization and User records now. You can now create this field type for Organizations and Users, in order to display associated UTA records for an Organization or User.<br />
<!--94789 - Special Linked Record List - Expand to Org/Contact Profiles Display--><br />
<br />
===Minor Updates===<br />
====Hashtags for Easier Searching and Classification====<br />
Users can now easily find organizations, people, grants, and other records using hashtags. Simply enter the desired hashtag (e.g. #SummerEvents) into the custom field to tag it for later or to easily connect records from other applications. To enable hashtags on any '''Text Box - Multiple Lines''' or '''Text Box - Single Line''', go to the custom field settings and toggle on '''Enable Hashtag''' under '''Feature Options'''.<br />
<!--117344 - hashtag feature--><br />
<br />
[[File:2020-11-ticket-117344-1.png|thumb|none|800px|Easily search and classify records using hashtags.]]<br />
<br />
====Enhanced ORCID Integration Experience====<br />
Researchers, scientists, and academic professionals with ORCID accounts can more easily import their ORCID data. Information from your ORCID account such as grants, awards, and annual funding can be seen in an improved overview on your profile. The improved ORCID process can be enabled by using the new ORCID User Standard Field found under '''Global Settings''' > '''Users''' tab > '''Standard Fields'''. To import data, users can simply navigate to the ORCID tab on their profile’s left navigation and follow the onscreen directions to start the import process.<br />
<!--117794 - Improved ORCID Profile Import Experience--><br />
<br />
[[File:2020-11-ticket-117794-1.png|thumb|none|800px|The new ORCID tab and message seen on your profile before you import your data.]]<br />
<br />
[[File:2020-11-ticket-117794-2.png|thumb|none|800px|The enhanced ORCID summary seen on your profile after you import your data.]]<br />
<br />
====New Option for Limited Custom Fields to Enforce Unique Values====<br />
New option for '''Text Box - Single Line''' and '''Number''' custom field types to enforce unique values across records. Within the configuration of these custom field types, there is a new option within the validation section that will enforce unique values for this custom field upon saving of a record.<br />
<!--91772 - Duplicate check on Text Box field--><br />
<br />
====New Display Options for Portal Shortcuts====<br />
New display options available for portal shortcuts linked to list views. When configuring a portal shortcut of list view type with an icon or image, there's a new option to show the count of the records returned by the list view. In addition, there's now a new setting to allow you to enter instructions or display text for a shortcut.<br />
<!--93214 - add count option to image and icon shortcuts with an underlying list view--><br />
<!--108449 - Shortcut list view instructions--><br />
<br />
[[File:2020-11-ticket-93214-1.png|thumb|none|800px|Icon portal shortcuts with the new option to show counts enabled.]]<br />
[[File:2020-11-ticket-93214-2.jpg|thumb|none|800px|Image portal shortcuts with the new option to show counts enabled.]]<br />
<br />
====New Option for Autoloader Import to Skip Update of Matched Records====<br />
Updated the Autoloader import feature with ability to skip update of matched records. Previously, the only options for Autoloader behaviour were to either update matched records and create new, or to only update matched records and not create new. You may now configure an Autoloader to only import new records and skip update of existing matched records.<br />
<!--87721 - Autoloader - Skip Duplicate--><br />
<br />
==Beta Previews==<br />
No features are available for beta preview this upgrade.<br />
<br />
==Notes for Admins==<br />
====Added Change Log History for Workflow Configuration====<br />
Added change history logs for Worfklow configuration. Changes to Workflows, Tasks, and Connectors will now be logged, and visible via a change history icon when configuring each of these areas. Please note that workflow history records older than 2 years will now be deleted to improve system performance.<br />
<!--89641 - Changelog for Workflows & 87147 - Clear Workflow History--><br />
<br />
====Added Support for use of Dynamic Criteria with Report Caching====<br />
Added support for inclusion of dynamic criteria supplied to reports at run-time for report caching. Previously, the caching feature for reports did not support the use of run-time criteria, but has now been enhanced. This means that you can enable the result caching feature for reports that take input criteria at run-time to speed up the delivery of repeat report results and improve your system performance.<br />
<!--114589 - Consider dynamic parameter in Report Cache--><br />
<br />
====Updated System Summary Document to Include IDs of Configuration Settings====<br />
Updated the '''System Summary''' document to also list the unique identifier for each of the configurations. Previously, this document output only included the names of each of the settings configured, but will now also include the IDs of each of these settings.<br />
<!--89681 - include ids in system design summary--><br />
<br />
====Added Language Translation Configurations for Custom Batch Update Buttons====<br />
Extended language translation availability to custom batch update buttons. You can now configure language translations for the labels of custom batch update buttons.<br />
<!--89276 - Translate Batch Button--><br />
<br />
====New Translations Available====<br />
New translations are available for '''Global Administrators''' in Japanese (日本語), Catalan (Català), and Irish (Gaeilge).<br />
<br />
====Accessibility Improvements====<br />
'''Accessibility Mode''' has been enhanced for greater keyboard accessibility. New warnings have been added to the custom field configuration screen that will alert admins when a custom field has been configured with HTML markup that is not recommended. We encourage the use of semantic tags (''strong'' and ''em'') rather than ''b'' and ''i'' tags to ensure a more accessible experience.<br />
<!--93961 - A11Y check for b and u and I tags on custom fields on save--><br />
<br />
====Updated Archive Schedule with Ability to Upload to SFTP Site====<br />
Updated the '''Archive Schedule''' data backup feature with ability to upload data to an external SFTP site.<br />
<!--115538 - Enhancements to the archive Process--><br />
<br />
====Enhanced Primary Authentication Controller with Ability to Restrict by Role====<br />
Enhanced the [[Primary Authentication Controller|'''Primary Authentication Controller''']] feature with the ability to limit the access to individual authentication links to other instances based upon user role. This will allow you to more granularly control the access to specific authentication links, and thus other instances.<br />
<!--86335 - PAC access Role Base--><br />
<br />
====End of Support for Internet Explorer 11====<br />
Microsoft's support for Internet Explorer will end November 2020. We recommend using [[Browser|the latest browser versions]] of Chrome, Firefox or Safari for the best platform experience.</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SSlogic&diff=37623SSlogic2020-08-07T20:25:52Z<p>DEardley: </p>
<hr />
<div>[[Web Page View Field|Web Page View]] fields can use a unique [[SmartSimple]] logic interpreter. Web page logic gives you the ability to display certain content or perform certain actions only when specified conditions are met.<br />
[[SmartSimple]] logic uses the following syntax:<br />
<br />
<pre><br />
<!--@sslogic(CONDITION)--><br />
The content to be displayed when condition is true.<br />
This can be more than one line.<br />
<!--@end--><br />
</pre><br />
<br />
* The content to be displayed (the middle line) can either be in plaintext or in HTML.<br />
* Be sure there are quotes (single or double) around the variable and value. Note: Your choice in the use of quotes depends on the variable's contents. E.g. names containing apostrophes should use double quotes when referencing that variable.<br />
* SSlogic does not support nested logic statements. In other words, you cannot put an sslogic statement within another sslogic statement. <br />
* NOTE: You cannot use sscalculation syntax within an sslogic statement. The sslogic syntax will manage the calculating. It does not require additional syntax prompts.<br />
<br />
<br />
'''Example:'''<br />
<br />
* The following will display a Christmas tree image if the month is December:<br />
<br />
<pre><br />
<!--@sslogic(month(now())=12)--><br />
<img src="images/xmasstree.jpg" alt="" /><br />
<!--@end--><br />
</pre><br />
<br />
* Precede the equal sign with an exclamation point to test for '''Not Equal'''<br />
* The following will display a message for all provinces except Ontario:<br />
<br />
<pre><br />
<!--@sslogic("@province@"!="Ontario")--><br />
You are outside of Ontario<br />
<!--@end--><br />
</pre><br />
<br />
==Else Logic==<br />
* Often, you will want to display one of two texts--one text in the case that a condition is met and another in the case that the condition is not met. This is achieved through the use of an "else" operator.<br />
* The following sample code will display one message if a user is male and another if the user is female:<br />
<br />
<pre><br />
<!--@sslogic("@sex@"="M")--><br />
You are a guy.<br />
<!--@else--><br />
You are a girl.<br />
<!--@end--><br />
</pre><br />
<br />
* The following will display 2 check boxes. If the gender is male the first check box (Male) will be ticked. If the gender is female the second check box will be ticked:<br />
<br />
<pre><br />
<!--@sslogic('@parent.owner.clientgender@'='Male')--><br />
<input checked="checked" type="checkbox" /> Male<br />
<input type="checkbox" /> Female<br />
<!--@else--><br />
<input type="checkbox" /> Male<br />
<input checked="checked" type="checkbox" /> Female<br />
<!--@end--><br />
</pre><br />
<br />
==Multiple Options ("else if" syntax):==<br />
You can use multiple "else if" operators if there are more than just 2 options:<br />
<br />
<nowiki><!--@sslogic(</nowiki>''condition 1'')-->aaa<br />
<nowiki><!--@else if(</nowiki>''condition 2'')-->bbb <br />
<nowiki><!--@else if(</nowiki>''condition 3'')-->ccc <br />
<nowiki><!--@else-->ddd </nowiki><br />
<nowiki><!--@end--></nowiki></nowiki></nowiki></nowiki><br />
<br />
'''Example:'''<br />
<br />
<pre><!--@sslogic("@possibility@"="Yes")--><br />
This will happen for certain.<br />
<!--@else if("@possibility@"="No")--><br />
This is not happening. <br />
<!--@else if("@possibility@"="Maybe")--><br />
This may or may not happen.<br />
<!--@else--><br />
No-one knows what will happen.<br />
<!--@end--></pre><br />
<br />
<!--per support ticket 17150 - Else if for sslogic --><br />
==Multiple Conditions==<br />
* You can include more than one condition:<br />
<br />
<pre><br />
<!--@sslogic('@year@'='2008' AND ('@month@'='1' OR '@month@'='2'))--><br />
This is only displayed if the year is 2008 and the month is either Jan or Feb.<br />
<!--@end--><br />
</pre><br />
<br />
==Fields Storing Single Quotes==<br />
* SSlogic can be used to display fields that may have a single quote stored within them.<br />
* The escape[] function is used to achieve this:<br />
<br />
<pre><br />
<!--@sslogic('escape["137762$]'!='')--><br />
</pre><br />
<br />
==Using Object Lists==<br />
* Object [[Web_Page_View_Field_Variables#List|Lists]] can also be used in SSlogic.<br />
<br />
<pre><br />
<!--@sslogic("[#(?object=contact::criteria=rolename='Supervisor'::groupfunction=count)~userid~#]">0)--><br />
There is at least one Supervisor<br />
<!--@else--><br />
There are no Supervisors<br />
<!--@end--><br />
</pre><br />
<br />
==Using With SSattach==<br />
* SSlogic can be used to determine which pdf file is appended to the Web Page View using '''ssattach'''<br />
* The following example will attach ''myfilefooter.pdf'' if the Type/Template is Contract, and ''myotherfilefooter.pdf'' if not:<br />
<br />
<pre><br />
<!--@sslogic("@type@"="Contract")--><br />
<!--@ssattach(after;/files/1234/123/myfilefooter.pdf)--><br />
<!--@else--><br />
<!--@ssattach(after;/files/1234/123/myotherfilefooter.pdf )--><br />
<!--@end--><br />
</pre><br />
:: '''''Note:''' [[ssattach]] can be used without sslogic if you want the same pdf file attached to the Web Page View in all cases.''<br />
==Notes==<br />
* SSlogic can be used in workflow e-mails at Level 1 only.<br />
* In general, double quotes (") should be used to enclose variables rather than single quotes ('). If the content includes an apostrophe (equivalent to a single quote) it will disrupt the processing. Double quotes are less common as content. You may want to add an [[Removing Special Characters|onchange]] to the source field to prevent entry of double quotes.<br />
<br />
==See Also==<br />
* [[Web Page View Field]]<br />
* [[Web Page View Field Variables]]<br />
* [[sscalculation]]<br />
<br />
<br />
[[Category:Custom Fields]][[Category:Variables]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Template:July2020Upgrade&diff=37557Template:July2020Upgrade2020-06-25T16:02:26Z<p>DEardley: /* Extended Display of Record Type and Status Colour to Provider/Consumer List Views */</p>
<hr />
<div>==General Details==<br />
===Upgrade Dates===<br />
Public Cloud Production release date: '''July 9th 2020'''<br /><br />
Public Cloud Backup release date: '''June 25th 2020'''<br />
<br />
Private Cloud Production (Managed Upgrades) release date: '''July 23rd 2020'''<br /><br />
Private Cloud Backup (Managed Upgrades) release date: '''July 9th 2020'''<br />
<br />
==Overview==<br />
Watch this video to get a general overview of the new features in this release.<br />
<br />
<!--{{#ev:youtube|b778GtKgl2M}}--><br />
<br />
''To watch this video in full screen, please click on the '''full screen''' button on the bottom right.''<br />
<br />
==Global System Upgrades==<br />
The new features listed below are enhancements to the SmartSimple system and will be immediately available to SmartSimple users upon the application of the upgrade to their server:<br />
<br />
===Major Updates===<br />
<br />
====Deprecated Downloads Page====<br />
Deprecated the Downloads menu, and support for the two desktop apps that were listed, Outlook Plugin, and Online File Editor.<br />
<!--109308 - Download Page--><br />
<br />
====Deprecated Special - Password Protected Text Custom Field====<br />
Deprecated the Special - Password Protected Text type custom field as it is using outdated encryption methodology that is no longer secure. The current custom fields will continue to work as before, but you will not be able to create new fields of this type.<br />
<!--112573 - Netcraft VA 202002 issues - V15 Weak encryption scheme for password-protected text fields--><br />
<br />
====Changed the Arrangement of Options Context Menu====<br />
Updated the arrangement of options within the action menu bar for improved organization and ease of use of the menu. The previous Options menu has been separated and grouped into three new menus Actions, Tools, and Logs in order to better separate the type of functions that you can perform for a record. Some functions have been migrated into the pre-existing New menu, and the New menu has been swapped in position with the Edit/View action.<br />
<!--91709 - Option menu changes--><br />
<br />
[[File:2020-07-ticket-91709-1.png|thumb|none|500px|Options menu prior to upgrade.]]<br />
<br />
[[File:2020-07-ticket-91709-2.png|thumb|none|500px|Options menu separated into new menus after the upgrade.]]<br />
<br />
====Changed Behaviour and Updated List of Currency Fields====<br />
Updated the list of available currencies, as well as behaviour of select input for various currency selectors throughout both admin configuration pages, a well as end user interface pages. Currency fields, including the UTA Level 1 Currency standard field, have been updated to a more recent listing of global currencies. The field has been updated to show you both the currency code as well as full name of the currency, also now allows you to search on either text, and lastly the sorting has been updated to be fully sorted alphabetically.<br />
<!--88659 - Expand the list of currencies available in the UTA L1 SF Currency--><br />
<br />
[[File:2020-07-ticket-88659-1.png|thumb|none|500px|Currency standard field on a UTA level 1 such as a grant prior to upgrade.]]<br />
<br />
[[File:2020-07-ticket-88659-2.png|thumb|none|500px|Currency standard field on a UTA level 1 such as a grant after the upgrade.]]<br />
<br />
====Changed Behaviour and Visibility of SmartFolders for SmartFolder Manager Users====<br />
Updated the visibility of SmartFolders to always be visible to users that possess the SmartFolders - Manager Feature Permission. Previously, users with this manager role were still able to access SmartFolders regardless of what role permissions were set on the SmartFolder, however the SmartFolder interface was not correctly displaying these folders as visible. An update has been made to correct this so that the SmartFolder interface now correctly shows all folders as visible since SmartFolder Manager users already had access to these. The effect is that SmartFolder Manager users may now see more SmartFolders in their list than they did previously since they have the access to modify all folders.<br />
<!--91896 - Global Admin cannot view SmartFolder that they do not own--><br />
<br />
====Updated Interface for Greater Screen Real Estate====<br />
New Compact Mode introduced for users who wish to view and work with more information on screen. This setting is labelled Enable/Disable Compact and is found under the user menu at the top right of the header. This will improve the amount of workspace for users that are comfortable with a higher density of information on screen. This was designed with staff and power users in mind that work day to day with lists and large forms. Also, some minor updates have been made to the interface for all users to create more screen real estate. Specifically, the spacing and font sizing in the top header bar has been slightly reduced to grant you more usable screen real estate.<br />
<!--110413 - UI Changes for more working space--><br />
<br />
[[File:2020-07-ticket-110413-1.png|thumb|none|500px|List view with the default display density.]]<br />
<br />
[[File:2020-07-ticket-110413-2.png|thumb|none|500px|List view with compact display density on where you can see twice as many records per page.]] <br />
<br />
[[File:2020-07-ticket-110413-3.png|thumb|none|500px|UTA level 1 such as a grant with default display density.]]<br />
<br />
[[File:2020-07-ticket-110413-4.png|thumb|none|500px|UTA level 1 such as a grant with compact display density on where you can see more fields per page.]]<br />
<br />
====Changed Behaviour of Variable Processor Replacement of Display - Image Custom Fields====<br />
Changed the variable replacement of Display - Image custom fields. Previously, when this type of custom field was referenced from a list syntax in the variable processor, e.g. using [#(?object=)#], the path to the thumbnail image was returned. The variable processor has been updated to instead return the path to the original image, and a new syntax has been created to reference the thumbnail version. Specifically, Display - Image custom fields that were referenced in a list syntax, like [#(?object=) $field.value$#], used to return the path to the thumbnail image. This will instead return the path to the full image after this upgrade, and if you wish to reference the thumbnail you can do so with new syntax like $field.thumbnail$. This may impact the size of file, and result in larger files, for any documents that you currently generate that reference these fields in this manner.<br />
<!--113439 - Displaying images from image upload--><br />
<br />
====Changed Behaviour of System Configuration Lock====<br />
Updated the System Configuration Lock feature to no longer require a static password to lock or unlock the system, but rather just verify the user's current account password. As this feature is only available to Global Administrators via the Global Settings, we've removed the requirement for a static password for ease of use, as this was never designed as a security feature but rather as an added confirmation before locking or unlocking the system.<br />
<!--110171 - System Configuration lock update--><br />
<br />
====Changed Behaviour of Access Control for Edit of Consumer Association Custom Fields====<br />
Changed the access control for editing custom fields attached to Consumer association roles. Previously, for custom fields within a Consumer association link, in order to edit these, the system required that a user have the access to both edit the field, as well as to add Consumer links to the parent Provider. Now, the system will only require that the user have the access to edit the fields and will not require the access to add Consumer links.<br />
<!--112592 - Unable to edit Connection Role Custom Field unless allowed to assign existing consumers--><br />
<br />
====Enhanced Password and Activation Settings Page====<br />
Enhanced the Password and Activation settings pages for improved navigation, ease of use, as well as stronger default security settings. The interface for these pages has been updated in line with a left navigation menu. Some settings now have updated labels, and descriptions, and may have been re-organized between tabs to be more intuitive to find. The password policy and complexity has been updated in order to easily configure your password complexity requirement. Previously, the password complexity would be a compiled logic statement, which can still be made via a custom policy, however now by default the password complexity is a set of toggles and options that is easy to both set as well as read. Also, with the new Default password complexity type, we've updated the interface to validate a user's password as they type to provide a better user experience when updating their password. We encourage you to review your password complexity settings and easily switch over to the new Default complexity type. Please note that the options for minimum character requirement have been updated from a minimum of 6 instead up to 8 characters now.<br />
<!--109890 - Password and Activation Policies - Password Pattern--><br />
<br />
====New Portal Configuration Mode====<br />
New Portal Configuration Mode now allows you to easily edit the configuration and contents of your portal interfaces. This option can be found when you open a portal preview and allows you to directly edit the portal while visually reviewing it.<br />
<!--96926 - configuration mode for portals phase 2--><br />
<br />
[[File:2020-07-ticket-96926-1.jpg|thumb|none|500px|1) Enable Configuration Mode via the Portal Preview mode, 2) Indicator that Configuration Mode is enabled, 3) Click the gear icon to edit the settings of a section, 4) Click the pencil icon to directly edit the text on-screen.]]<br />
<br />
====Enhanced Translation Functionality for Password and Activation Settings Page====<br />
Enhanced the Password and Activation settings with stronger translation functionality. You can now create separate language translation configurations for these similar to other areas in the system with the translation button located at the top left action bar when viewing the settings page. You can add translations for the password complexity validation, as well as the various welcome and password email reset email templates.<br />
<!--106654 - Password and Activation Policies translations--><br />
<br />
====New Placeholder Text Provided when Configuring Language Translations====<br />
Enhanced system setting pages that allow for language translations to show you the original label value for improved ease of use. Previously, when configuring a new translation text for any setting, it was difficult to review the original text as you were presented with blank inputs. Now, the system will initially present you with placeholder text of the original label values so you can easily translate them in place. An example of this can be seen when entering a language translation for a list view.<br />
<!--52475 - Displaying read only English column names in list views when entering labels for other languages--><br />
<br />
[[File:2020-07-ticket-52475-1.png|thumb|none|500px|Prior to the upgrade, when entering translations into a list view, the inputs were empty.]]<br />
<br />
[[File:2020-07-ticket-52475-2.png|thumb|none|500px|After the upgrade, when entering translations for a list view, the inputs will contain English placeholder text until you enter a translation.]]<br />
<br />
====Added Navigation Bar for Configuration Screens====<br />
Extended the Hierarchical Record Navigation bar into configuration pages for improved navigation and user experience for system administrators. This will help you to better visualize the relationship between certain complex settings, and for navigating between screens easier. This will simplify the navigation between different levels of settings pages, for example, flipping between UTA settings, down to the custom field configuration, and back.<br />
<!--90026 - Custom field context - navigation bar--><br />
<br />
[[File:2020-07-ticket-90026-1.png|thumb|none|500px|After the upgrade the hierarchical navigation bar will appear on configuration pages such as the Level 1 Custom Field. Note you can navigate direct to the UTA List, the UTA Settings page and the list of Level 1 custom fields with a single click.]]<br />
<br />
====Deprecated Classic Interface====<br />
Removed the ability to re-enable the Classic interface, and will no longer be supporting the Classic interface. A previous upgrade would have automatically converted any instances still using Classic interface to the current Arcadia interface so there should be no impact to most clients. We have now fully removed the option in Global Settings -> Classic Options -> Disable Classic Mode that would have allowed you to revert back to the Classic interface.<br />
<!--113575 - QA Issue: Classic Interface on User Profiles--><br />
<br />
====Deprecated Pre-Built System Reports====<br />
Removed a number of pre-built system reports that are no longer relevant. There were a number of reports that referenced older deprecated applications or areas of the system that have now been removed to clear away some clutter in the Reports listing.<br />
<!--113543 - Remove all Global Reports from Reports Menu--><br />
<br />
====New MS Word Parser Function====<br />
New MS Word parser function available for file upload custom fields. Similar to the previously released Excel parser function, this feature allows you to upload templated Word files which the system can read and perform updates to custom fields, and even create or update records as well. In order to use this feature you will need to first create a Word template with set inputs and tables. Next, configure the file upload custom field with the definition and mapping between the table names and SmartSimple fields.<br />
<!--111029 - MS Word Parser--><br />
<br />
===Minor Updates===<br />
<br />
====Updated Personal Dashboards with Ability to Link Shortcuts to List Views====<br />
Updated personal dashboards with the ability for you to link aggregate shortcuts and charts to list views. Users with personal dashboards will now find the Link to List View option available to them when editing a aggregate-type item in their dashboard.<br />
<!--83521 - Personal Dashboards - Sections link to list views--><br />
<br />
====Updated Personal List Views with Ability to Bulk Download Files====<br />
Updated personal list views with the ability to bulk download file attachments. Introduced the option to Enable File Download when editing a personal list view.<br />
<!--88221 - Enable Download Files for Personal List Views--><br />
<br />
====Updated Global Listing of Email Templates====<br />
Updated the global list of email templates to include configured email templates from more system areas. This list can be found in Global Settings -> Communications -> System Emails and conveniently displays a list of all the email templates configured throughout the system, allowing you to easily review and update these as necessary from this central list.<br />
<!--109816 - All emails in one place phase 2--><br />
<br />
====Extended the Standard Rich Text Editor for all Email Template Configuration====<br />
Updated the consistency of areas used for composing emails. Standardized the two options for the format of Email Body content, and the Editor that you wish to edit the email body with. This introduces the Rich Text Editor for the editing of email templates in areas that previously didn't have support for the Rich Text Editor.<br />
<!--108384 - invitation templates use rich text builder--><br />
<br />
====Enhanced User Filtering Options for Notification Broadcasts====<br />
Enhanced Notification Broadcasts with the ability to use system filters to better target users for messaging. This allows you to apply very specific user filters to your various notification messages.<br />
<!--101982 - Notification Broadcast - Targeted Notifications and Workflow Driven Notifications--><br />
<br />
====Extended Display of Record Type and Status Color to Provider/Consumer List Views====<br />
Extended more base functionality for Provider/Consumer list views to display type and status colours for the records listed, as well as advanced search functionality.<br />
<!--53589 - Consistency in consumer/provider list view--><br />
<br />
====Additional Fields Made Available for Batch Update====<br />
Added additional fields available to Batch Update in List Views. You can now use Batch Update to update certain standard fields such as UTA record Start Date, and End Date.<br />
<!--106035 - Batch Updating Standard Fields--><br />
<br />
====New Current Usage Info for Shortcut Configuration====<br />
Updated configuration page for user role shortcuts to show you which portal sections they're being used on. You can now more easily determine where shortcuts are being used. Please note, this listing only shows where shortcut has been explicitly selected for a portal section of type Shortcuts, and the shortcut may still be used in a Shortcut section that shows all shortcuts.<br />
<!--107481 - For Shortcuts, show which sections they are used on--><br />
<br />
====Added SmartCard Count Info to SmartCard Selection Screen====<br />
Updated the SmartCard selection page to show you a count of records linked to each SmartCard. Now, when adding a record to a SmartCard, the SmartCard selection page will show you a count of the number of records linked to each SmartCard.<br />
<!--95338 - Record counts on smartcards--><br />
<br />
====Extended Ability to Copy UTA Type and Status Configurations====<br />
Extended the copy function for the configuration of UTA types and statuses. You now have the ability to copy an existing type or status and its current settings in order to create similar types and statuses faster. This option will appears as a Save As button when viewing an existing type or status.<br />
<!--90248 - Save As Function for Type and Status--><br />
<br />
====New Option for Workflow Task to Update SmartVersion ID of UTA Record====<br />
New option for Workflow task to be able to update the SmartVersion ID of a UTA Level 1, 2, or 3 record. This option can be found in the task type for updating standard fields.<br />
<!--93566 - Add VersionID to the list of fields available in the Update Standard Field Value workflow task--><br />
<br />
====Updated Sorting Options for Notes Panel====<br />
Updated the Notes panel with an option for you to select the order to list the Notes in, either newest to oldest or oldest to newest.<br />
<!--85559 - Enhancement Request - Notes section Sorting on ascending order--><br />
<br />
====New Ability for Users to Opt Out of System Emails====<br />
New personal setting for users to opt out of system emails. When set, this will prevent the system from sending any emails to the user where they are the main recipient in the TO field. Note that this will prevent the email from being sent entirely so any other parties in the email CC will also not receive the email. Also, this setting does not affect the sending of emails where the user is included in the email CC, password resets, or manually constructed emails such as Group Emails.<br />
<!--109645 - (DUB) Opt-out emails from the system--><br />
<br />
====Fixed Issue with Visibility of Personal Settings Link in User Menu====<br />
Fixed an issue with the visibility of the personal settings link to now correctly be hidden from the user menu in the top menu bar if the Visibility Permission for hiding the user settings menu is true.<br />
<!--111245 - Should Personal Settings be hidden from User Profile and User Menu--><br />
<br />
==On-Demand System Upgrades==<br />
The following features are available immediately with the application of the upgrade, but must first be enabled or configured by a System Administrator:<br />
<br />
===Major Updates===<br />
<br />
====New Ability to Define Colours for Charts====<br />
New ability to define the colours used to represent specific groups of values in a chart. This allows you to build a dashboard of multiple charts and coordinate the same colour scheme used within each. Due to the variability of return values between each chart, the colour definition is configured for each individual chart. For example, given multiple charts that show aggregated amounts based on country, you will need to define the colour to be used for values "Canada", "United States",...etc. in each chart. This functionality has been made available to those charts created from list views, and is not available to charts created from reports.<br />
<!--65330 - Ability to choose colour in list view charts and dashboards--><br />
<br />
[[File:2020-07-ticket-65330-1.png|thumb|none|500px|Define the series colors in list view charts found in portals and in personal dashboards.]]<br />
<br />
[[File:2020-07-ticket-65330-2.png|thumb|none|500px|The settings for defining series colors for a card on a personal dashboard.]]<br />
<br />
====New Option to Limit Available User Roles for Association to UTA Record Types====<br />
New ability to limit the available user roles that you may assign a user as to a UTA Level 1, 2, or 3 record based upon the UTA record type. This setting can be found when configuring the multiple contacts standard field for UTA Level 1, 2, or 3 types, and allows you to define a subset of user roles that a user may be assigned as to each type.<br />
<!--106811 - Add ability to determine which type contact roles are available for--><br />
<br />
====New Title Bar Navigation Panel====<br />
New Title Bar Anchor Navigation feature allows you to display a navigation pane on forms that allows users to easily navigate between various titled sections of a form. The setting has been introduced as a global instance-wide setting found in Global Settings -> Branding, and when enabled will manifest a navigation pane with links to the various Title Bar fields that you have configured on your forms.<br />
<!--111287 - Improved tabs and record completion--><br />
<br />
[[File:2020-07-ticket-111287-1.png|thumb|none|500px|The new optional Title Bar Anchor Navigation as seen on a level 1 like a grant.]]<br />
<br />
====New Form Completion Indicator====<br />
New Form Completion Indicator feature allows you to display the current percentage completion of a form as the user fills it out. The setting can be configured granularly for UTA records, users, or organizations, for example in the UTA Settings -> Level 1 Settings -> you can define the user roles that see this indicator, and for which record types and statuses. This provides end users with a visual estimate of how much work they've completed and how much is left. This feature will automatically calculate the percentage complete based on the number of fields available for input by the user, and indicates both the overall form completion as well as per section as defined by fields contained within each custom field of type Layout - Tabbed Section. You may even adjust the default weighting of each Layout - Tabbed Section against the overall form completion.<br />
<!--111287 - Improved tabs and record completion--><br />
<br />
[[File:2020-07-ticket-111287-2.png|thumb|none|500px|Form completion indicators as seen on a level 1 such as a grant.]]<br />
<br />
====New Option to Configure Duplicate Check of Rows in Advanced Data Table Fields====<br />
New ability to configure a duplicate check across columns within the sections of a Advanced Data Table custom field. This setting will allow you to enforce uniqueness across the rows of a section. You can select one or more columns to include in this by toggling the Enable Duplicate Check setting per column.<br />
<!--91097 - Enable Duplicate Checking Configuration within dynamic XML sections--><br />
<br />
====Extended Contact Invitations to be Available for UTA Level 3 Records====<br />
Extended the contact invitations feature to be made available for UTA Level 3 records. You can now enable this feature in order to invite and associate contacts to your Level 3s.<br />
<!--91471 - Invitation feature on Level 3--><br />
<br />
====Extended Contact Invitations for use in Linked Record List Fields====<br />
New option in the Special - Linked Record List custom field type to be able to connect to contact invitations. You can now have a greater ability to configure the display, and access to invitations.<br />
<!--91418 - Expand Linked Record List Field to Include Invitations--><br />
<br />
[[File:2020-07-ticket-91418-1.png|thumb|none|500px|Showing invitations on a level 1 such as a grant using the Special - Linked Record List custom field.]]<br />
<br />
====Extended Quick Assignment to be Available for UTA Level 2 and 3 Records====<br />
Extended the Quick Assignment feature to be available to UTA Level 2 and 3 types now. Previously, this feature was only available for UTA Level 1s. This feature allows you to quickly and easily assign users to UTA records in bulk.<br />
<!--96279 - Allow Quick Assign on Level 2--><br />
<br />
====New Option to Limit Available List Views for use in Quick Assignment Pane====<br />
Enhanced the Quick Assignment feature with option to use a configurable set of list views. You may now specify a set of default list views to be used for the Quick Assignment panel for easier and more intuitive use.<br />
<--105966 - Quick Assign enhancement, default list view per type for Contacts/Applications--><br />
<br />
====New Integration with Scopus Publication Database====<br />
New integration with Scopus publication database available. You can enable integration with Scopus in order for users to import their publication details from their database.<br />
<!--110138 - (DUB) Integration with Scopus and Web of Science--><br />
<br />
====New Integration with Web of Science Publication Database====<br />
New integration with Web of Science publication database available. You can enable integration with Web of Science in order for users to import their publication details from their database.<br />
<!--110138 - (DUB) Integration with Scopus and Web of Science--><br />
<br />
===Minor Updates===<br />
<br />
====Extended Language Translation Functionality for Advanced Data Table Sections====<br />
Enhanced the Advanced Data Table custom field with the ability to configure language translations for each section. You can now configure different language translations for this field much more easily.<br />
<!--85747 - Advanced Data Table XML sections with multi language support--><br />
<br />
====Extended Language Translation Functionality for Organization and User Signup Pages====<br />
Enhanced the Organization and User signup pages with the ability to configure language translations. You can now configure different language translations for signup pages much more easily without having to create separate signup pages. The language selector previously located under the Description text area, has been moved up into the top left action bar and will function similar to more recent implementations of language translations for configuration pages. Note that existing configurations will still function as before, and this change will only apply to new signup pages.<br />
<!--85834 - Ability to support multiple language on signup pages--><br />
<br />
====New Options for the Limit of User Lookup on UTA Records Based on Associated Organizations====<br />
New ability to configure the user lookup for UTA Level 1 contact-related standard fields to be limited to users of the multiple organization associations, or users that are associated to attached organizations. Within the UTA Level 1 standard field settings, you now have more options to limit the selection of the owner based upon the various organizations attached to the Level 1. Previously, the organization-based contact filtering options were limited to just the internal Branch and external Company organizations.<br />
<!--91586 - Add option to include users of associated company in Owner for L1 record lookup scope--><br />
<br />
====New Options for the Limit of User Lookup on UTA Records Based on User Status====<br />
New ability to configure the user lookup restriction for various contact-related standard fields based on user statuses. User standard fields such as UTA Level 1 Owner or Person now have an added option to restrict the user lookup results to only users with specific status values. Also, added the ability to filter lookup results to users of specific statuses in addition to user roles when performing the look up of these contacts on the record.<br />
<!--93146 - Contact LookUp Listview - Missing filter option--><br />
<br />
====New Option to Specify Minimum Number of Files Required for Upload====<br />
New ability to specify a validation requirement for both the minimum and maximum number of files uploaded to a custom field. We've introduced the minimum file setting so that you can set more granular validation on the number of files required for upload rather than just mandatory and maximum files.<br />
<!--91081 - Minimum Amount of Upload Files--><br />
<br />
====New Option to Re-Order Shortcuts within a Portal Shortcut Section====<br />
Updated the settings page for portal sections that display shortcuts to allow you to re-order the shortcuts. Previously, shortcuts followed a global sort order, but you can now re-order shortcuts if necessary within each individual shortcut-type portal section.<br />
<!--88124 - Shortcuts order phase 2--><br />
<br />
====New Option to Show Create New Record for List Views Opened from Portal Shortcut====<br />
New option to show the create new record button for a list view opened from a portal shortcut. In the settings page of a user role shortcut set to a list view, an option has been introduced to show the create new button, and also allows you to set the default type and status of the new record to be created.<br />
<!--93788 - Add 'Show new button' option to portal short cuts--><br />
<br />
====New Managed Template Page for Login Pages====<br />
New ability to set Login pages to use the default system template that will be automatically managed and updated inline with the platform interface over time. Previously, when configuring a Login page, using the default system template would generate a static Login page that never changed. In an effort to continually keep your system up to date and in line with the latest industry standards and requirements, we encourage you to set your Login pages to this new Default Page Layout and allow SmartSimple upgrades to manage them.<br />
<!--70204 - Login page default template enhancement option--><br />
<br />
====New Option to Limit Auto-Assignment of Organization Primary Contact by User Role====<br />
New option to limit the assignment of an organization's primary contact to specific user roles. Moved the Default Primary Contact toggle, which automatically assigns the first user registered under an organization, to the Organization's Primary Contact standard field settings. Added an additional role selector when the Default Primary Contact is turned on. If this new setting is used, the next user created with one of the selected roles in an organization with no primary contact will be assigned as the primary contact. This can help in situations where you may have multiple contacts register an organization and the desired primary contact is not necessarily the first user to register.<br />
<!--89877 - Restrict primary contact auto assignment to specific system role(s)--><br />
<br />
====New Date Range Input Available to Search Panels within Portal Sections====<br />
New date range input made available to search panels within a portal section. When you enable the search panel for a portal section, and make a date field available for searching, you now have the option of selecting Date Range as the comparison operator in order to easily create a prompt for both start and end date range.<br />
<!--93193 - pick date range through single ui--><br />
<br />
[[File:2020-07-ticket-93193-1.png|thumb|none|500px|The new date range input option for search panels in list view portal sections.]]<br />
<br />
====New Option to set Workflow Trigger Times Dynamically Based Upon Field Values====<br />
Updated Workflow task connectors with the ability to use a dynamic trigger time derived from the trigger date field. Previously, connectors were limited by only allowing a static trigger time to be set. Now, you'll be able to specify that the connector should use the time value stored within the trigger date field, which can be either a standard field, such as Start/End Date, or a custom field, such as Date and Time type fields.<br />
<!--65101 - Workflow Dynamic Trigger Time--><br />
<br />
====Enhanced Configuration Folders with Ability to Trigger Workflows on File Upload====<br />
Enhanced the Configuration Folders under SmartFolders with the ability to trigger Workflows on file upload, similar to the classic SmartFolders.<br />
<!--109098 - Add Workflow option to configuration folders--><br />
<br />
====Enhanced Stripe Integration with Ability to Auto-Create UTA Level 2 Records====<br />
Enhanced the Stripe integration functionality with the ability to auto-generate UTA Level 2 payment records. The Stripe integration was designed to create a UTA Level 3 as Stripe payment receipt or status from a Level 2 payment request. Now, we've enhanced this feature with the ability to automatically create a Level 2 stub before the system creates the Level 3 Stripe record as before.<br />
<!--108639 - Stripe Integration - Expand for use on L1 with Auto-Creation of L2 payment and payment form--><br />
<br />
==Beta Previews==<br />
No features are available for beta preview this upgrade.<br />
<br />
==Notes for Admins==<br />
<br />
====New Ability to Limit the Application of Save Formulas to a SmartVersion====<br />
New ability to limit the application of Save Formulas to only run for specific SmartVersions. The formula trigger points that allow you to limit Formulas to only run for specific record types or statuses has been expanded to include versions as well. You can now apply different formulas to different version records. Using the keyword "version", and a value of the version's name you can write the trigger point like the following:<br />
<br />
{"formula trigger" : [{"version" : "YOUR VERSION NAME HERE"}]}::YOUR FORMULA HERE<br />
<!--84918 - (DUB) Using Active Version in formula trigger--><br />
<br />
====New Ability to Assign Save Formulas to Consumer Creation Buttons====<br />
New ability to configure Save Formulas for Consumer Creation Buttons when using Provider/Consumer UTA linkage. This allows you to more easily transfer values from a Provider record to a Consumer record on creation of the Consumer record. First, define a Consumer Creation Formula by navigating to the Provider UTA -> UTA Settings -> Connectivity -> Consumer Creation Formulas. Note that only the new Platform3 variable syntax is supported for this feature as denoted in the tooltip there. Second, after this, you will be able to select which Save Formula to use per Consumer Creation Button when editing them.<br />
<!--85391 - (DUB) Applications inheriting field values from a set of call values--><br />
<br />
====New Ability to Configure Deny Condition for Consumer Creation Buttons====<br />
New ability to configure deny condition for Consumer Creation Buttons when using Provider/Consumer UTA linkage. You can now configure a deny condition based upon a user's organization status that will disable the ability to use the Consumer Creation Button. For example, if an organization is in a restricted status, or hasn't passed a verification or approval process, you can have the system prevent its users from creating new applications.<br />
<!--88695 - Check Org status on Consumer Creation Button--><br />
<br />
====New Ability to Configure Consumer Creation Buttons to Link Multiple Providers====<br />
New option for Consumer Creation Button to associate additional Provider records on creation of the Consumer record when you have Provider/Consumer configuration setup in your system. This can be applicable where you have multiple Provider/Consumer relationships setup in your system, for example three UTAs X, Y, Z, e.g. a Budget UTA, Program Manager UTA, Submission UTA, such that there are Provider Consumer relationships for X -> Y -> Z, and also X -> Z. In this case, when creating the consumer record in UTA Z from UTA Y, the system can automatically also link the UTA X records to Z, that were associated to the UTA Y record. These new settings can be found when configuring the Consumer Creation buttons from the Provider UTA, in the above example UTA Y.<br />
<!--95096 - Enhance Consumer Creation Button--><br />
<br />
====Updated SmartConnect API Get Meta Call with Additional Return Info====<br />
Updated the SmartConnect API Get Meta functionality to include information related to the type-availability of custom fields. For example, UTA custom fields that have a Field Availability set to include or exclude specific record types will now return this meta data from the SmartConnect API call. Within a field object node, we've introduced a new object node "typeavailability", with attributes "includefortypes", and "excludefortypes" that return a string of comma-delimited typeids if configured. For example, a UTA Level 1 field that is only available for Level 1 types 123, 456, and 789, will return a value in "includefortypes" of "123,456,789". UTA Level 2, and Level 3 custom fields have an additional setting that allows the definition of field availability based on the parent L1 type, so API calls for these fields will have additional attributes "includeforlevelonetypes", and "excludeforlevelonetypes".<br />
<!--113599 - Enhance the JSON Meta Data API--><br />
<br />
====Enhanced ORCID Integration with Ability to Auto-Populate ORCID ID====<br />
Enhanced the integration with ORCID publications with the ability to also populate a custom field with the ORCID ID value when importing a user profile from ORCID.<br />
<!--107012 - ORCID Integration Surface ORCID ID--></div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Variable_List&diff=37337Variable List2020-01-14T21:40:45Z<p>DEardley: /* Level 2 */</p>
<hr />
<div>==System Variables==<br />
''This refers to [[System Variables]] defined on the [[Global Settings]] page''<br />
<br />
* '''@system.'''''customfieldname'''''@'''<br />
<br />
==System Library Variables==<br />
''This refers to System Library Variables defined on the [[Global Settings]] page''<br />
<br />
* '''@system.library.'''''variable name'''''@'''<br />
<br />
'''Note''': Library variables are available in all instances but can only be created and edited by SmartSimple.<br />
<br />
==System-Wide Variables==<br />
'''@currentdate@'''<br />
<br />
* Inserts the current date and time<br />
<br />
* This can be used in most areas where variables are called<br />
<br />
==Web Page View Variables==<br />
'''@now@'''<br />
<br />
* Inserts the current system date<br />
<br />
==Local Time Variable==<br />
'''@localhour(fullstartdate)@'''<br />
<br />
* Adding the word local before the variable displays the hour based on the system time zone and not default Eastern time. The same can be used for minutes and for am/pm.<br />
<br />
==Universal Tracking Application Variables==<br />
===Level 1===<br />
{| class="wikitable"<br />
|+style="text-align:left"|Level 1 Field Name and Variable List<br />
|-<br />
!|Field Name<br />
!|Variable<br />
|-<br />
||level 1 name field<br />
||@name@<br />
|-<br />
||level 1 type field<br />
||@type@<br />
|-<br />
||level 1 status field<br />
||@status@<br />
|-<br />
||level 1 start date<br />
||@startdate@<br />
|-<br />
||level 1 end date<br />
||@enddate@<br />
|-<br />
||level 1 contact<br />
||@contact@<br />
|-<br />
||level 1 custom field<br />
||@customfieldname@<br />
|-<br />
||Accounts<br />
||No variables<br />
|-<br />
||Activity List<br />
||No variables<br />
|-<br />
||Application Name<br />
||@name@<br />
|-<br />
||Application Template Type<br />
||@type@<br />
|-<br />
||Application Template Type Caption<br />
||@typecaption@<br />
|-<br />
||Application Template Type Language<br />
||@type_lang@<br />
|-<br />
||Archived<br />
||@archived@<br />
|-<br />
||Branch<br />
||@branch@<br />
|-<br />
||Branch ID<br />
||@branchid@<br />
|-<br />
||Close Date<br />
||@closedate@<br />
|-<br />
||Contacts<br />
||No variables<br />
|-<br />
||Currency Name<br />
||@currencyname@<br />
|-<br />
||Currency Code<br />
||@currencycode@<br />
|-<br />
||Exchange Currency Name<br />
||@excurrencyname@<br />
|-<br />
||Exchange Currency Code<br />
||@excurrencycode@<br />
|-<br />
||Currency Exchange Rate<br />
||@exrate@<br />
|-<br />
||Customer<br />
||@client@<br />
|-<br />
||Description<br />
||@description@<br />
|-<br />
||End Date<br />
||@enddate@<br />
|-<br />
||End Time<br />
||@hour(fullenddate)@:@minute(fullenddate)@<br />
|-<br />
||Folders<br />
||No variables<br />
|-<br />
||Modified By<br />
||@modifiedby@ (username); @modifiedbyid@ (userid)<br />
|-<br />
||Modified Date<br />
||@modifieddate@<br />
|-<br />
||Owner (full name)<br />
||@owner@<br />
|-<br />
||Owner (full name - Consumer/Provider reference)<br />
||@ownername@<br />
|-<br />
||Owner (userid)<br />
||@ownerid@<br />
|-<br />
||Person (full name)<br />
||@person@<br />
|-<br />
||Person (userid)<br />
||@person.userid@<br />
|-<br />
||Probability<br />
||@probability@<br />
|-<br />
||Requirement<br />
||@requirements@<br />
|-<br />
||Revenue<br />
||@revenue@<br />
|-<br />
||Revenue<br />
||@revenue.value@ (unformatted number without comma separators)<br />
|-<br />
||Start Date<br />
||@startdate@<br />
|-<br />
||Start Time<br />
||@hour(fullstartdate)@:@minute(fullstartdate)@<br />
|-<br />
||Status<br />
||@status@<br />
|-<br />
||Status ID<br />
||@statusid@<br />
|-<br />
||Status Caption<br />
||@statuscaption@<br />
|-<br />
||Status Language<br />
||@status_lang@<br />
|-<br />
||Status Name<br />
||@statusname@<br />
|-<br />
||Workflow<br />
||No variables<br />
|}<br />
<br />
===Level 2===<br />
{| class="wikitable"<br />
|+style="text-align:left"|Level 2 Field Names and Variables List<br />
|-<br />
!|Field Name<br />
!|Variable<br />
|-<br />
||'''Activity Type'''<br />
||@type@<br />
|-<br />
||'''Activity Type [[Caption]]'''<br />
||@typecaption@<br />
|-<br />
||'''Activity Type ID'''<br />
||@typeid@<br />
|-<br />
||'''Amount'''<br />
||@eamount@<br />
|-<br />
||'''Assigned Links'''<br />
||''No variables''<br />
|-<br />
||'''Assigned People'''<br />
||@assigned@<br />
|-<br />
||'''Contact Links'''<br />
||''No variables''<br />
|-<br />
||'''Contact People'''<br />
||@contact@<br />
|-<br />
||'''Contact User ID'''<br />
||@contact.userid@ -- Returns one only, even with multiple contacts assigned<br />
|-<br />
||'''Description'''<br />
||@description@<br />
|-<br />
||'''Duration'''<br />
||@span@<br />
|-<br />
||'''End Date'''<br />
||@enddate@<br />
|-<br />
||'''End Hour''' (0-23)<br />
||@endhour@<br />
|-<br />
||'''End Hour''' (1-12)<br />
||@endh@<br />
|-<br />
||'''End Hour AM or PM'''<br />
||@endampm@<br />
|-<br />
||'''End Minute'''<br />
||@endminute@<br />
|-<br />
||'''End Time'''<br />
||@endhour@:@endminute@<br />
|-<br />
||'''Event ID'''<br />
||@eventid@<br />
|-<br />
||'''Follow-up Days'''<br />
||''No variables''<br />
|-<br />
||'''Follow-up Sent'''<br />
||''No variables''<br />
|-<br />
||'''Follow-up Type'''<br />
||''No variables''<br />
|-<br />
||'''Location'''<br />
||@location@<br />
|-<br />
||'''Object ID''' (Parent system ID)<br />
||@objectid@<br />
|-<br />
||'''Object Type'''<br />
||@objecttype@<br />
|-<br />
||'''Owner'''<br />
||@owner@<br />
|-<br />
||'''Owner ID'''<br />
||@eownerid@<br />
|-<br />
||'''Parent Name'''<br />
||@parent.name@<br />
|-<br />
||'''Reminder Days'''<br />
||''No variables''<br />
|-<br />
||'''Reminder Sent'''<br />
||''No variables''<br />
|-<br />
||'''Reminder Type'''<br />
||''No variables''<br />
|-<br />
||'''Root Company ID'''<br />
||@rootcompanyid@<br />
|-<br />
||'''Start Date'''<br />
||@startdate@<br />
|-<br />
||'''Start Hour''' (0-23)<br />
||@starthour@<br />
|-<br />
||'''Start Hour''' (1-12)<br />
||@starth@<br />
|-<br />
||'''Start Hour AM or PM'''<br />
||@startampm@<br />
|-<br />
||'''Start Minute'''<br />
||@startminute@<br />
|-<br />
||'''Start Time'''<br />
||@starthour@:@startminute@<br />
|-<br />
||'''Status'''<br />
||@status@<br />
|-<br />
||'''Status [[Caption]]'''<br />
||@statuscaption@<br />
|-<br />
||'''Subject'''<br />
||@subject@<br />
|-<br />
||'''Updated By'''<br />
||@updatedby@ -- Displays system ID, not name<br />
|-<br />
||'''Updated By Name'''<br />
||@updatedbyname@ -- Displays the name<br />
|-<br />
||'''Whole Day Event'''<br />
||@isallday@<br />
|}<br />
<br />
===Level 3===<br />
{| class="wikitable"<br />
|+style="text-align:left"|Level 3 Field Names and Variables<br />
|-<br />
!|Field Name<br />
!|Variable<br />
|-<br />
||'''Associated Parent'''<br />
||@linkparent.''fieldname''@<br />
|-<br />
||'''General'''<br />
||Level 3 uses the same variables as Level 2.<br />
|}<br />
<br />
===Calling a Level 1 Variable at Level 2===<br />
'''@parent.branch@''' or '''@parent.client@''' will be replaced by company name and other fields can be referenced like this:<br />
<br />
* '''@parent.branch.address@'''<br />
* '''@parent.branch.country@'''<br />
* '''@parent.branch.customfield@'''<br />
* '''@parent.firstname@'''<br />
* '''@parent.lastname@'''<br />
* '''@parent.description@'''<br />
* '''@parent.status@'''<br />
* '''@parent.person.fieldname@''' - fieldname will be replaced by the variables listed below for the '''Person''' [[Standard Field]] at Level 1.<br />
<br />
whatever fields available for company object.<br />
<br />
==Contacts/Users==<br />
{| class="wikitable"<br />
|+style="text-align:left"|Contacts/Users Field Names and Variables<br />
|-<br />
!|Field Name<br />
!|Variable<br />
|-<br />
||'''First name'''<br />
||@firstname@<br />
|-<br />
||'''Middle name'''<br />
||@middlename@<br />
|-<br />
||'''Last name'''<br />
||@lastname@<br />
|-<br />
||'''Full name'''<br />
||@fullname@<br />
|-<br />
||'''Phone'''<br />
||@phone@<br />
|-<br />
||'''Phone extension'''<br />
||@uphoneext@<br />
|-<br />
||'''Company name'''<br />
||@company@<br />
|-<br />
||'''Address'''<br />
||@address@<br />
|-<br />
||'''Address 2'''<br />
||@address2@<br />
|-<br />
||'''City'''<br />
||@city@<br />
|-<br />
||'''Province'''<br />
||@province@<br />
|-<br />
||'''State'''<br />
||@state@<br />
|-<br />
||'''Country'''<br />
||@country@<br />
|-<br />
||'''Country Code''' (2 letter abbreviation)<br />
||@countrycode@<br />
|-<br />
||'''Postal code'''<br />
||@postalcode@<br />
|-<br />
||'''Primary Address'''<br />
||@primaryaddress@ - used with [[Multiple Address Types]]. See [[Address Book Template]]<br />
|-<br />
||'''Address Book'''<br />
||@addressbook@ - used with [[Multiple Address Types]]. See [[Address Book Template]]<br />
|-<br />
||'''US Region name from an actual address record'''<br />
||@address.region.uscounty.name@<br />
|-<br />
||'''US Region ID from an actual address record'''<br />
||@address.region.uscounty.id@<br />
|-<br />
||'''Owner'''<br />
||@owner@<br />
|-<br />
||'''Last updated'''<br />
||@modifieddate@<br />
|-<br />
||'''Last logged in'''<br />
||@lastlogin@<br />
|-<br />
||'''Cost'''<br />
||@cost@<br />
|-<br />
||'''Cost unit'''<br />
||@costunit@<br />
|-<br />
||'''Type'''<br />
||@type@ (returns 'User', 'Local User Administrator' or 'Global User Administrator')<br />
|-<br />
||'''Access Type'''<br />
||@accesstype@ (returns 'Administration or Portal Interface', 'User Centric or Applicant Interface', 'Web Service User' or 'No Access')<br />
|-<br />
||'''Access Type ID'''<br />
||@accesstypeid@ ''0=No Access;1=Administration or Portal Interface;3=User Centric or Applicant Interface;5=Web Service User;''<br />
|-<br />
||'''Resource name'''<br />
||@resourcename@<br />
|-<br />
||'''Is contact a resource?'''<br />
||@isresource@<br />
|-<br />
||'''Prefix'''<br />
||@prefix@<br />
|-<br />
||'''Suffix'''<br />
||@suffix@<br />
|-<br />
||'''Unique Identifier'''<br />
||@uuid@ This is a system-generated code that is unique to each contact. For example: ''6BCC 98SF EFC6 FFFB 270C 606''<br />
|-<br />
||'''Language'''<br />
||@langname@ The Language name in the [[Personal Settings]] of the contact (i.e.: ''@me.langname@'' or ''@owner.langname@'')<br />
|-<br />
||'''Language ID Code'''<br />
||@langid@ The Language selected in the [[Personal Settings]] of the contact (i.e.: ''@me.langid@'' or ''@owner.langid@''). See [[Language|here]] for more information<br />
|-<br />
||'''User's Time Zone setting'''<br />
||@sstimezone@ (can be used to calculate user's relative date/time)<br />
|}<br />
<br />
==When calling on Level 1 and Level 2 information from a Level 2 Workflow==<br />
{| class="wikitable"<br />
|+style="text-align:left"|Calling L1 and L2 fields from a L2 Workflow<br />
|-<br />
!|Field Name<br />
!|Variable<br />
|-<br />
||'''level 1 name field'''<br />
||@parent.name@<br />
|-<br />
||'''level 1 status'''<br />
||@parent.status@<br />
|-<br />
||'''level 1 start date'''<br />
||@parent.startdate@<br />
|-<br />
||'''level 1 end date'''<br />
||@parent.enddate@<br />
|-<br />
||'''level 1 contact'''<br />
||@parent.contact@<br />
|-<br />
||'''level 1 custom fields'''<br />
||@parent.customfieldname@<br />
|-<br />
||'''level 2 type field'''<br />
||@type@<br />
|-<br />
||'''level 2 status field'''<br />
||@status@<br />
|-<br />
||'''level 2 start date'''<br />
||@startdate@<br />
|-<br />
||'''level 2 end date'''<br />
||@enddate@<br />
|-<br />
||'''level 2 contact'''<br />
||@contact@<br />
|-<br />
||'''level 2 custom field'''<br />
||@customfieldname@<br />
|}<br />
<br />
==Parent can be Company, Level 1, Opportunity or Leads==<br />
<u>'''Company'''</u><br />
<br />
State|@state@|-><br />
<br />
{| class="wikitable"<br />
|+style="text-align:left"|Level 1 Name and Variable List<br />
|-<br />
!|Name<br />
!|Variable<br />
|-<br />
||'''Primary Contact'''<br />
||@primarycontact@<br />
|-<br />
||'''Company Name'''<br />
||@name@<br />
|-<br />
||'''Address'''<br />
||@address@<br />
|-<br />
||'''Address 2'''<br />
||@address2@<br />
|-<br />
||'''City'''<br />
||@city@<br />
|-<br />
||'''Province'''<br />
||@province@<br />
|-<br />
||'''Postal code'''<br />
||@postalcode@<br />
|-<br />
||'''Country'''<br />
||@country@<br />
|-<br />
||'''Country Code''' (2 letter abbreviation)<br />
||@countrycode@<br />
|-<br />
||'''Latitude'''<br />
||@lat@<br />
|-<br />
||'''Longitude'''<br />
||@lng@<br />
|-<br />
||'''Phone number'''<br />
||@phone@<br />
|-<br />
||'''Fax number'''<br />
||@fax@<br />
|-<br />
||'''Owner'''<br />
||@owner@<br />
|-<br />
||'''Website'''<br />
||@website@<br />
|-<br />
||'''Custom fields'''<br />
||@customfields@<br />
|-<br />
||'''NAIC Code 1'''<br />
||@naiccode1@<br />
|-<br />
||'''NAIC Code 2'''<br />
||@naiccode2@<br />
|-<br />
||'''Last updated'''<br />
||@modifieddate@<br />
|-<br />
||'''Last updated by'''<br />
||@updatedbyname@<br />
|-<br />
||'''Category custom fields'''<br />
||@Field Name@<br />
|}<br />
<br />
==Opportunity, Level 1==<br />
{| class="wikitable"<br />
|+style="text-align:left"|Opportunity & Level 1<br />
|-<br />
!|Field Name<br />
!|Variable<br />
|-<br />
||'''Branch'''<br />
||@branch@<br />
|-<br />
||'''Close Date'''<br />
||@closedate@<br />
|-<br />
||'''Company field'''<br />
||@company.field@<br />
|-<br />
||'''Contacts'''<br />
||@contact.rolename.field@<br />
|-<br />
||'''Created Date'''<br />
||@createddate@<br />
|-<br />
||'''Currency'''<br />
||@currency@<br />
|-<br />
||'''Customer'''<br />
||@client@<br />
|-<br />
||'''Description'''<br />
||@description@<br />
|-<br />
||'''End Date'''<br />
||@enddate@<br />
|-<br />
||'''End Time'''<br />
||@hour(fullenddate)@:@minute(fullenddate)@<br />
|-<br />
||'''Folders'''<br />
||No variables<br />
|-<br />
||'''Opportunity Source'''<br />
||@leadsource@<br />
|-<br />
||'''List Job Questions (with combo boxes)'''<br />
||@jobquestions@ ''Only for opportunities that use the recruiting template''<br />
|-<br />
||'''List Job Questions (just questions)'''<br />
||@jobquestionsr@<br />
|-<br />
||'''List Job Skills'''<br />
||@jobskills@<br />
|-<br />
||'''Modified Date'''<br />
||@modifieddate@<br />
|-<br />
||'''Number of filled positions'''<br />
||@candidatefilled@<br />
|-<br />
||'''Number of open positions'''<br />
||@openpositions@<br />
|-<br />
||'''Owner'''<br />
||@owner@<br />
|-<br />
||'''Opportunity Name'''<br />
||@name@<br />
|-<br />
||'''Opportunity Type'''<br />
||@type@<br />
|-<br />
||'''Probability'''<br />
||@probability@<br />
|-<br />
||'''Requirements'''<br />
||@requirements@<br />
|-<br />
||'''Revenue'''<br />
||@revenue@<br />
|-<br />
||'''Start Date'''<br />
||@startdate@<br />
|-<br />
||'''Start Time'''<br />
||@hour(fullstartdate)@:@minute(fullstartdate)@<br />
|-<br />
||'''Status'''<br />
||@status@<br />
|-<br />
||'''Template type number'''<br />
||@templatetype@<br />
|}<br />
<br />
<!--* '''Accounts''' - No variables <br />
* '''Activity List''' - Is not displaying information properly, according to Wiki call guide <br />
* '''Applicants''' - No information on how to call applicants in Wiki --><br />
==Leads==<br />
{| class="wikitable"<br />
|+style="text-align:left"|Leads Variable List<br />
|-<br />
!|Field Name<br />
!|Variable<br />
|-<br />
||'''Status'''<br />
||@status@<br />
|-<br />
||'''Company'''<br />
||@name@<br />
|-<br />
||'''Address'''<br />
||@address@<br />
|-<br />
||'''Address 2'''<br />
||@address2@<br />
|-<br />
||'''City'''<br />
||@city@<br />
|-<br />
||'''Province'''<br />
||@province@<br />
|-<br />
||'''Country'''<br />
||@country@<br />
|-<br />
||'''Postal'''<br />
||@postalcode@<br />
|-<br />
||'''Phone'''<br />
||@phone@<br />
|-<br />
||'''Fax'''<br />
||@fax@<br />
|-<br />
||'''Web Site'''<br />
||@website@<br />
|-<br />
||'''First Name'''<br />
||@firstname@<br />
|-<br />
||'''Last Name'''<br />
||@lastname@<br />
|-<br />
||'''Prefix'''<br />
||@prefix@<br />
|-<br />
||'''Suffix'''<br />
||@suffix@<br />
|-<br />
||'''Title'''<br />
||@title@<br />
|-<br />
||'''(Contact) Phone'''<br />
||@contactphone@<br />
|-<br />
||'''Email'''<br />
||@email@<br />
|-<br />
||'''Description'''<br />
||@description@<br />
|-<br />
||'''Date Added'''<br />
||@dat_added@<br />
|}<br />
<br />
<!--* '''Campaign''' - Don’t know--><br />
<!--* '''NAIC 1''' - Don’t know <br />
<br />
* '''NAIC 2''' - Don’t know--><br />
<!--* '''Ext.''' - Don’t know--><br />
<!--* '''Owner/Owner.field''' - Don’t know--><br />
==Email Broadcast==<br />
{| class="wikitable"<br />
|+style="text-align:left"|Email Broadcast Variable List<br />
|-<br />
!|Field Name<br />
!|Variable<br />
|-<br />
||'''@rolename.customfield@'''<br />
||<br />
|-<br />
||'''@randompassword@'''<br />
||Generates a new password when sending to user<br />
|-<br />
||'''@password@'''<br />
||Generates a new password when sending to user<br />
|-<br />
||'''@email@'''<br />
||Sends the username/E-mail<br />
|-<br />
||'''@userid@'''<br />
||Sends the user id<br />
|-<br />
||'''@sender.''fieldname''@'''<br />
||manner of referencing details of the user who is sending the email<br />
|}<br />
: '''Note:'''<br />
:* examples: ''@sender.company.address@'' will return the address of the sender's company.<br />
:* Includes '''All standard contact fields'''<br />
:* Includes '''All standard company fields'''<br />
<br />
==Contacts==<br />
{| class="wikitable"<br />
|+style="text-align:left"|Level 1 Field Name and Variable List<br />
|-<br />
!|Field Name<br />
!|Variable<br />
|-<br />
||'''First name of contact or lead'''<br />
||@firstname@<br />
|-<br />
||'''Last name of contact or lead'''<br />
||@lastname@<br />
|-<br />
||'''Full name of contact or lead'''<br />
||@fullname@<br />
|-<br />
||'''Title of contact or lead'''<br />
||@title@<br />
|-<br />
||'''Email address of contact or lead'''<br />
||@email@<br />
|-<br />
||'''Phone number of contact or lead'''<br />
||@phone@<br />
|-<br />
||'''Address of contact or lead'''<br />
||@address@<br />
|-<br />
||'''City of contact or lead'''<br />
||@city@<br />
|-<br />
||'''State/Province of contact or lead'''<br />
||@state@<br />
|-<br />
||'''Country of contact or lead'''<br />
||@country@<br />
|-<br />
||'''Country Code of contact or lead'''<br />
||@countrycode@<br />
|-<br />
||'''Zip/Postal code of contact or lead'''<br />
||@postalcode@<br />
|-<br />
||'''Company name of contact or lead'''<br />
||@companyname@<br />
|-<br />
||'''Contact address - not available for lead'''<br />
||@caddress@<br />
|-<br />
||'''Contact city - not available for lead'''<br />
||@ccity@<br />
|-<br />
||'''Contact state/province - not available for lead'''<br />
||@cstate@<br />
|-<br />
||'''Contact country - not available for lead'''<br />
||@ccountry@<br />
|-<br />
||'''Contact postal code - not available for lead'''<br />
||@cpostalcode@<br />
|-<br />
||'''Contact fax - not available for lead'''<br />
||@cfax@<br />
|-<br />
||'''Web site for lead - not available for contact'''<br />
||@cwebsite@<br />
|-<br />
||'''First name of the sender'''<br />
||@senderfirstname@<br />
|-<br />
||'''Last name of the sender'''<br />
||@senderlastname@<br />
|-<br />
||'''Name of sender company'''<br />
||@sendercompany@<br />
|-<br />
||'''E-mail of sender'''<br />
||@senderemail@<br />
|-<br />
||'''Phone number of sender'''<br />
||@senderphone@<br />
|-<br />
||'''Title of sender'''<br />
||@sendertitle@<br />
|-<br />
||'''Current date and time format selected by the user in their personal settings ? long date format'''<br />
||@now@<br />
|-<br />
||'''Description field content'''<br />
||@objectdescription@<br />
|}<br />
<br />
==Roles==<br />
'''@rolelist@''' provides a list of [[roleid]]s corresponding to the roles the user belongs to.<br />
<br />
@me.rolelist@<br />
<br />
'''@primaryroleid@''' provides the id for the user's primary role. Do not use the prefix '@me.'.<br />
<br />
@primaryroleid@<br />
<br />
==Organization Categories==<br />
'''@catlist@''' lists the roleid of each Organization Category the company (Account/Organization) belongs to.<br />
<br />
@me.parent.catlist@<br />
<br />
==Custom Fields attached to Roles==<br />
'''@rolename.customfieldname@'''<br />
<br />
==[[Using Variables in the Report Builder|Variables available for Report criteria]]==<br />
* '''@userid@'''<br />
* '''@companyid@'''<br />
* '''@objectid@'''<br />
<br />
The following variable is used to report on data that is on records in a sub-company<br />
@company.childid(x)@ where x is index of children ordered by name (1,2,3,4,5,6....n)<br />
<br />
==Using Variables in the Report Template Header==<br />
* '''@args[1]@, @args[2]@''' - used within Report Template Header to obtain the criteria entered by users.<br />
* '''@runtime@''' - used within Report Template Header to obtain date/time report was run.<br />
<br />
==Applicant Tracking Email Template Variables==<br />
The following variables are used to create email templates:<br />
<br />
<u>'''Job Fields'''</u><br />
<br />
{| class="wikitable"<br />
|+style="text-align:left"|Job Fields Variable List<br />
|-<br />
!|Field Name<br />
!|Variable<br />
|-<br />
||@job.name@<br />
||'''Job name'''<br />
|-<br />
||@job.client@<br />
||'''Associated name of the client'''<br />
|-<br />
||@job.stage@<br />
||'''Status of the job'''<br />
|-<br />
||@job.closedate@<br />
||'''Hiring close date of the job'''<br />
|-<br />
||@job.manager@<br />
||'''Hiring Manger – set on the job page'''<br />
|-<br />
||@job.description@<br />
||'''Job description'''<br />
|-<br />
||@job.type@<br />
||'''Template name for this job'''<br />
|-<br />
||@job.startdate@<br />
||'''Job start date'''<br />
|-<br />
||@job.enddate@<br />
||'''Job end date – contract only'''<br />
|-<br />
||@job.requirements@<br />
||'''Job requirements'''<br />
|-<br />
||@job.openpositions@<br />
||'''Number of open positions'''<br />
|-<br />
||@job.applicantfilled@<br />
||'''Number of hired applicants'''<br />
|-<br />
||@job.branch@<br />
||'''Internal branch name associated with this job'''<br />
|-<br />
||@job.branch.address@<br />
||'''Internal branch address 1'''<br />
|-<br />
||@job.branch.address2@<br />
||'''Internal branch address 2'''<br />
|-<br />
||@job.branch.city@<br />
||'''Internal branch city'''<br />
|-<br />
||@job.branch.state@<br />
||'''Internal branch state/province'''<br />
|-<br />
||@job.branch.phone@<br />
||'''Internal branch phone number'''<br />
|-<br />
||@job.branch.country@<br />
||'''Internal branch country'''<br />
|-<br />
||@job.branch.postalcode@<br />
||'''Internal branch zip/postal code'''<br />
|-<br />
||@job.branch.website@<br />
||'''Internal branch web site address'''<br />
|-<br />
||@job.client@<br />
||'''Client name'''<br />
|-<br />
||@job.client.address@<br />
||'''Client address one'''<br />
|-<br />
||@job.client.address2@<br />
||'''Client address two'''<br />
|-<br />
||@job.client.city@<br />
||'''Client city'''<br />
|-<br />
||@job.client.state@<br />
||'''Client state/province'''<br />
|-<br />
||@job.client.phone@<br />
||'''Client phone number'''<br />
|-<br />
||@job.client.country@<br />
||'''Client country'''<br />
|-<br />
||@job.client.postalcode@<br />
||'''Client zip/postal code'''<br />
|-<br />
||@job.client.website@<br />
||'''Client web site'''<br />
|-<br />
||@job.custom@<br />
||'''Custom field associated with the job template. For example @job.additionalinfo@'''<br />
|}<br />
<br />
==Applicant Fields==<br />
{| class="wikitable"<br />
|+style="text-align:left"|Applicant Fields Variable List<br />
|-<br />
!|Field Name<br />
!|Variable<br />
|-<br />
||@applicant.firstname@<br />
||'''First name of the applicant'''<br />
|-<br />
||@applicant.lastname@<br />
||'''Last name of applicant'''<br />
|-<br />
||@applicant.title@<br />
||'''Title of applicant'''<br />
|-<br />
||@applicant.email@<br />
||'''Email address of applicant'''<br />
|-<br />
||@applicant.phone@<br />
||'''Phone number of applicant'''<br />
|-<br />
||@applicant.address@<br />
||'''Address of applicant'''<br />
|-<br />
||@applicant.city@<br />
||'''City of applicant'''<br />
|-<br />
||@applicant.state@<br />
||'''State/Province of applicant'''<br />
|-<br />
||@applicant.country@<br />
||'''Country of applicant'''<br />
|-<br />
||@applicant.countrycode@<br />
||'''Country code (2 letter abbreviation) of applicant'''<br />
|-<br />
||@applicant.postalcode@<br />
||'''Zip/Postal applicant'''<br />
|}<br />
<br />
==Hiring Manager Fields==<br />
{| class="wikitable"<br />
|+style="text-align:left"|Level 1 Field Name and Variable List<br />
|-<br />
!|Field Name<br />
!|Variable<br />
|-<br />
||@hiring manager.firstname@<br />
||'''First name of the hiring manager'''<br />
|-<br />
||@hiring manager.lastname@<br />
||'''Last name of the hiring manager'''<br />
|-<br />
||@hiring manager.title@<br />
||'''Title of the hiring manager'''<br />
|-<br />
||@hiring manager.email@<br />
||'''Email address of the hiring manager'''<br />
|-<br />
||@hiring manager.phone@<br />
||'''Phone number of the hiring manager'''<br />
|-<br />
||@hiring manager.address@<br />
||'''Address of the hiring manager'''<br />
<br />
|-<br />
||@hiring manager.city@<br />
||'''City of the hiring manager'''<br />
|-<br />
||@hiring manager.state@<br />
||'''State/Province of the hiring manager'''<br />
|-<br />
||@hiring manager.country@<br />
||'''Country of the hiring manager'''<br />
|-<br />
||@hiring manager.countrycode@<br />
||'''Country Code (2 letter abbreviation) of the hiring manager'''<br />
|-<br />
||@hiring manager.postalcode@<br />
||'''Zip/Postal code of the hiring manager'''<br />
|}<br />
<br />
==Sender Fields==<br />
{| class="wikitable"<br />
|+style="text-align:left"|Sender Fields Variable List<br />
|-<br />
!|Field Name<br />
!|Variable<br />
|-<br />
||@senderfirstname@<br />
||'''First name of the sender'''<br />
|-<br />
||@senderlastname@<br />
||'''Last name of the sender'''<br />
|-<br />
||@sendercompany@<br />
||'''Name of sender company'''<br />
|-<br />
||@senderemail@<br />
||'''Email address of sender'''<br />
|-<br />
||@senderphone@<br />
||'''Phone number of sender'''<br />
|-<br />
||@sendertitle@<br />
||'''Title of sender'''<br />
|-<br />
||@now@<br />
||'''Current date and time format selected by the user in their personal settings - long date format'''.<br />
|}<br />
<br />
In addition you can also refer to fields from the sender such as custom fields and company details by using '''@sender.xxxx@''' <br /><br />
These variables can be used within [[:Category:Email|Email]] and [[Workflow]] messages.<br />
<br />
<br />
<br />
{| class="wikitable"<br />
|-<br />
!|Field Name<br />
!|Variable<br />
|-<br />
||@sender.address@<br />
||'''Address of the sender'''<br />
|-<br />
||@sender.company.name@<br />
||'''Name of the company the sender is associated with'''<br />
|-<br />
||@sender.(custom field name)@<br />
||'''Refers to a custom field from the sender's profile'''<br />
|}<br />
<br />
==Workflow Specific Variables==<br />
The following variables can only be used in messages associated with workflows:<br />
<br />
{| class="wikitable"<br />
|+style="text-align:left"|Workflow Specific Variables List<br />
|-<br />
!|Field Name<br />
!|Variable<br />
|-<br />
||'''@objectname@'''<br />
||Name of the object in the workflow. This could be a file name, user name, company name, or an application name.<br />
|-<br />
||'''@originatorname@'''<br />
||The name of the person that originated the workflow. For example, this value could be the person that added a file to a workflow-enabled SmartFolder, or the name of a person that created a new person record.<br />
|-<br />
||'''@originatoremail@'''<br />
||E-mail address of originator.<br />
|-<br />
||'''@originatorphone@'''<br />
||Phone number of originator.<br />
|}<br />
<br />
{{Template:Signority Variables}}<br />
<br />
==Other Variables==<br />
{| class="wikitable"<br />
|+style="text-align:left"|Level 1 Field Name and Variable List<br />
|-<br />
!|Field Name<br />
!|Variable<br />
|-<br />
||'''@url@'''<br />
||The URL to the company alias for SmartSimple. For example: XXX.smartsimple.com – where XXX is the alias created by that company using the Company Setting page. If you wish to display the URL as a link you should type either: '''http://''' or '''https://''' in front of the reference in the instant message or e-mail template. For example: <nowiki>https://@url@</nowiki><br />
|-<br />
||'''@parentlist@'''<br />
||The full SmartSimple path to the object.<br />
|-<br />
||'''@apptype@'''<br />
||Will return the [[Determining the applicationid|application ID]] within the context of a given [[UTA]].<br />
|}<br />
<br />
<!--===Spreadsheet Custom Field===<br />
The data stored within a cell or range of cells on a [[Special - Spreadsheet]] custom fields can be referenced using:<br />
<br />
'''Syntax:'''<br />
*Single Cell:<br />
:<font size=3>@sps.''fieldname''.B2@</font><br />
<br />
*Range of Cells:<br />
:<font size=3>@sps.''fieldname''.A1:C1@</font><br />
:<font size=3>@sps.''fieldname''.A1:C3@</font><br />
<br />
'''Where:'''<br />
* ''fieldname'' is the name of the '''Spreadsheet''' custom field.<br />
--><br />
===Select One - User Group Custom Field===<br />
The details of the members of a group stored within a [[Select One - User Group]] custom field can be referenced using the following syntax:<br />
<br />
: <span style="font-size: medium;">'''[#(?object=group::id=@''fieldname''@) ... #]'''</span><br />
'''Where:'''<br />
<br />
* ''fieldname'' is the name of the '''Select One - User Group''' field.<br />
* Replace "..." with the contact [[variables]] you wish to display. ''i.e. ~lastname~<br />
<br />
The role the user is assigned within the group can be accessed using '''~role~''' in the above syntax.<br />
<br />
==See Also==<br />
* [[Web Page View Field Variables]]<br />
<br />
<br />
[[Category:Variables]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SmartSimple_Reports_and_Dashboards_Guide&diff=37245SmartSimple Reports and Dashboards Guide2019-11-08T20:43:41Z<p>DEardley: </p>
<hr />
<div>{{ DeprecatedPage }}<br />
<br />
Download the latest version of the [[SmartSimple]] Reports and Dashboards guide here:<br />
<br />
'''[http://smart.smartsimple.com/files/113/f102251/SmartSimple_-_Reports_and_Dashboards_-_March_07.pdf SmartSimple Reports and Dashboards Guide]'''<br />
<br />
[[Category:SmartSimple Documentation]][[Category:Training]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SsGet&diff=37183SsGet2019-10-16T21:04:18Z<p>DEardley: /* Returning information from Watch List */</p>
<hr />
<div>=General Overview=<br />
The ''ssGet'' variable is used to extract information from a number of databases. These include:<br />
<br />
* The [[OFAC, IRS, CRA Checks|OFAC (Office of Foreign Assets Control) database]]<br />
* Watch List Integration third party providers<br />
* U.S. [[Census Integration|census data]]<br />
* [[:Category:Janus|Janus]], SmartSimple’s Machine Learning tool.<br />
<br />
<br />
The syntax for the ''ssGet'' variable varies by the database from which information is being returned.<br />
<br />
==Configuration - Office of Foreign Assets Control (OFAC)==<br />
{{Template:ProfessionalServices}}<br />
<br />
On-request checks can be made against the OFAC's online database within SmartSimple. For example, on an organization [[profile]], a [[Web_Page_View_Field]] can be configured that exposes the following check results:<br />
<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.<br />
The syntax for configuring the OFAC check is as follows:<br />
<br />
: <span style="font-size: medium;">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</span><br />
===Settings Explained - Office of Foreign Assets Control (OFAC)===<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Entity<br />
||accepts "people", "company" or "all"<br />
|-<br />
||firstname<br />
||an individual's first name or company name<br />
|-<br />
||lastname<br />
||an individual's last name (will be ignored if entity is "company" or "all")<br />
|-<br />
||search options<br />
||accepts "1", "2" or "3"<br />
* 1 - search current object only (when "entity" is set to "people" or "company")<br />
* 2 - search people underneath (when "entity" is set to "company" only)<br />
* 3 - search current object and people underneath (when "entity" is set to "company" only)<br />
<br />
|-<br />
||rolelist<br />
||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).<br />
|-<br />
||meta template<br />
||Template of how "header" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[entity]]</nowiki>'' - search type<br />
* ''<nowiki>[[name]]</nowiki>'' - name of search result<br />
* ''<nowiki>[[recordcount]]</nowiki>'' - number of records returned by OFAC search<br />
* ''<nowiki>[[now]]</nowiki>'' - Current date<br />
''<nowiki>Example: "Search type : [[entity]] , Search for : [[name]], Records returned : [[recordcount]], Date :[[now]]"</nowiki>''<br />
<br />
|-<br />
||line template<br />
||Template of how "body" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[index]]</nowiki>'' - index number<br />
* ''<nowiki>[[id]]</nowiki>'' - OFAC ID for result<br />
* ''<nowiki>[[name]]</nowiki>'' - OFAC name for result<br />
* ''<nowiki>[[type]]</nowiki>'' - OFAC type for result<br />
* ''<nowiki>[[alias]]</nowiki>'' - other aliases used<br />
* ''<nowiki>[[details]]</nowiki>'' - returns OFAC designation for entity returned, including date updated in OFAC database<br />
* ''<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''.<br />
<br />
|}<br />
<br />
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 content of the [[Web_Page_View_Field]] may be configured simiarly to the example shown below:<br />
<br />
: [[Image:OFAC WPV.png|link=|800px]]<br />
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.<br />
<br />
<br />
<br />
==Configuration - Watch List Scanning==<br />
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.<br />
<br />
In Global Settings, under the Integrations tab, you will locate the Watch List Settings.<br />
<br />
The Watch List Settings provide the ability to enter your billing id and password for the third party service you are utilizing. <br />
<br />
<br />When utilizing CSI Web, there are settings to define the watch list(s) you wish to search against, and the scan threshold, which will dictate only being shown results that match or exceed the percentage match threshold.<br />
<br />
The list of supported third party services with CSI Web includes: <br />
<br />
* U.S. Bureau Of Industry and Security<br />
* Department of State - Bureau of International Security & *Nonproliferation list<br />
* Department of State - Defense Trade Controls Debarred Parties list<br />
* International Criminal Police Organization (INTERPOL)<br />
* Politically Exposed Persons, CIA Foreign Officials<br />
* Office of Inspector General<br />
* Excluded Parties List System provided by the General Services Administration (GSA)<br />
* Financial Crimes Enforcement Network<br />
* FinCEN Money Services Business<br />
* World Bank Ineligible Firms<br />
* Terrorist Exclusion List<br />
* FBI Most Wanted Fugitives<br />
<br />
<br />
When utilizing Lexis Nexis, the settings for which watch list services will be included in each scan, along with threshold settings, will be managed within your Lexis Nexis account and not within the SmartSimple instance.<br />
<br />
===Returning information from Watch List===<br />
The syntax for configuring the Watch List check is as follows:<br />
<br />
:: <span style="font-size: medium;">'''@ssGet(ServiceName,entity;;firstname;;lastname;;search options;;roleslist;;meta template;;line template<span style="color: #ff0000;">;;''additional search attribute''</span>)@'''</span><br />
The ServiceName is dependent on which third party service you are utilizing:<br />
<br />
: CSI Web: WatchList<br />
: Lexis Nexis: LexisNexis<br />
The 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.<br />
<pre style="padding-left: 30px;">@parent.client.xml.Board of Directors XML.boardDirectors.boardDirectorsAdd[#$ssGet(WatchList,company;;owner;;;;3;;Grant Seeker,Executive Director,Board Member;;<br />
<strong>Board Member Search:</strong> ~Name.nodevalue~<br />Matches Found: [[recordcount]];;</pre><br />
{| class="xmlSectionTable"<br />
|-<br />
! class="xmlHead"|Result<br />
! class="xmlHead"|ID<br />
! class="xmlHead"|Name<br />
! class="xmlHead"|Type<br />
! class="xmlHead"|Alias<br />
! class="xmlHead"|Details<br />
! class="xmlHead"|Score<br />
|- id="matchfound"<br />
| class="xmlCell"|[[index]]<br />
| class="xmlCell"|[[id]]<br />
| class="xmlCell"|[[name]]<br />
| class="xmlCell"|[[type]]<br />
||[[alias]]<br />
||[[details]]<br />
| class="xmlCell"|[[score]]<br />
|}<br />
<pre>;;unparsedname=~Name.nodevalue~)$#]@<br /><br /><br />
@ssGet(LexisNexis,people;;@firstname@;;@lastname@;;1;;;;<strong>Applicant Search:</strong> @firstname@ @lastname@<br />Matches Found: [[recordcount]];;</pre><br />
{| class="xmlSectionTable"<br />
|-<br />
! class="xmlHead"|Result<br />
! class="xmlHead"|ID<br />
! class="xmlHead"|Name<br />
! class="xmlHead"|Type<br />
! class="xmlHead"|Alias<br />
! class="xmlHead"|Details<br />
! class="xmlHead"|Score<br />
||[[alias]]<br />
||[[details]]<br />
| class="xmlCell"|[[score]]<br />
|}<br />
<pre>;;)@[[index]][[id]][[name]][[type]]<br />
<br />
</pre><br />
<br />
==Configuration - U.S. Census Online Database==<br />
@ssGet(FFD,FIPS;;@address@ @city@ @state@)@<br /><br />
@ssGet(FFD,Profile;;year;;Address or FIPS code;;level;;<nowiki>[[template]]</nowiki>)@<br /><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>)'''<br />
<br />
==Configuration - [[:Category:Janus|Janus]]==<br />
@ssGet(JANUS,modelname)@<br />
<br />
==See Also==<br />
:* [[Census Integration]]<br />
:* [[OFAC, IRS, CRA Checks|OFAC, IRS and CRA Checks]]<br />
:* [[:Category:Janus|Janus, SmartSimple’s Machine Learning tool]]<br />
[[Category:Integration]][[Category:External Data Source]][[Category:Variables]]<br />
<!-- OFAC OFACS ofac ofacs OFACs --></div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SsGet&diff=37182SsGet2019-10-16T20:57:33Z<p>DEardley: </p>
<hr />
<div>=General Overview=<br />
The ''ssGet'' variable is used to extract information from a number of databases. These include:<br />
<br />
* The [[OFAC, IRS, CRA Checks|OFAC (Office of Foreign Assets Control) database]]<br />
* Watch List Integration third party providers<br />
* U.S. [[Census Integration|census data]]<br />
* [[:Category:Janus|Janus]], SmartSimple’s Machine Learning tool.<br />
<br />
<br />
The syntax for the ''ssGet'' variable varies by the database from which information is being returned.<br />
<br />
==Configuration - Office of Foreign Assets Control (OFAC)==<br />
{{Template:ProfessionalServices}}<br />
<br />
On-request checks can be made against the OFAC's online database within SmartSimple. For example, on an organization [[profile]], a [[Web_Page_View_Field]] can be configured that exposes the following check results:<br />
<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.<br />
The syntax for configuring the OFAC check is as follows:<br />
<br />
: <span style="font-size: medium;">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</span><br />
===Settings Explained - Office of Foreign Assets Control (OFAC)===<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Entity<br />
||accepts "people", "company" or "all"<br />
|-<br />
||firstname<br />
||an individual's first name or company name<br />
|-<br />
||lastname<br />
||an individual's last name (will be ignored if entity is "company" or "all")<br />
|-<br />
||search options<br />
||accepts "1", "2" or "3"<br />
* 1 - search current object only (when "entity" is set to "people" or "company")<br />
* 2 - search people underneath (when "entity" is set to "company" only)<br />
* 3 - search current object and people underneath (when "entity" is set to "company" only)<br />
<br />
|-<br />
||rolelist<br />
||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).<br />
|-<br />
||meta template<br />
||Template of how "header" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[entity]]</nowiki>'' - search type<br />
* ''<nowiki>[[name]]</nowiki>'' - name of search result<br />
* ''<nowiki>[[recordcount]]</nowiki>'' - number of records returned by OFAC search<br />
* ''<nowiki>[[now]]</nowiki>'' - Current date<br />
''<nowiki>Example: "Search type : [[entity]] , Search for : [[name]], Records returned : [[recordcount]], Date :[[now]]"</nowiki>''<br />
<br />
|-<br />
||line template<br />
||Template of how "body" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[index]]</nowiki>'' - index number<br />
* ''<nowiki>[[id]]</nowiki>'' - OFAC ID for result<br />
* ''<nowiki>[[name]]</nowiki>'' - OFAC name for result<br />
* ''<nowiki>[[type]]</nowiki>'' - OFAC type for result<br />
* ''<nowiki>[[alias]]</nowiki>'' - other aliases used<br />
* ''<nowiki>[[details]]</nowiki>'' - returns OFAC designation for entity returned, including date updated in OFAC database<br />
* ''<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''.<br />
<br />
|}<br />
<br />
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 content of the [[Web_Page_View_Field]] may be configured simiarly to the example shown below:<br />
<br />
: [[Image:OFAC WPV.png|link=|800px]]<br />
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.<br />
<br />
<br />
<br />
==Configuration - Watch List Scanning==<br />
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.<br />
<br />
In Global Settings, under the Integrations tab, you will locate the Watch List Settings.<br />
<br />
The Watch List Settings provide the ability to enter your billing id and password for the third party service you are utilizing. <br />
<br />
<br />When utilizing CSI Web, there are settings to define the watch list(s) you wish to search against, and the scan threshold, which will dictate only being shown results that match or exceed the percentage match threshold.<br />
<br />
The list of supported third party services with CSI Web includes: <br />
<br />
* U.S. Bureau Of Industry and Security<br />
* Department of State - Bureau of International Security & *Nonproliferation list<br />
* Department of State - Defense Trade Controls Debarred Parties list<br />
* International Criminal Police Organization (INTERPOL)<br />
* Politically Exposed Persons, CIA Foreign Officials<br />
* Office of Inspector General<br />
* Excluded Parties List System provided by the General Services Administration (GSA)<br />
* Financial Crimes Enforcement Network<br />
* FinCEN Money Services Business<br />
* World Bank Ineligible Firms<br />
* Terrorist Exclusion List<br />
* FBI Most Wanted Fugitives<br />
<br />
<br />
When utilizing Lexis Nexis, the settings for which watch list services will be included in each scan, along with threshold settings, will be managed within your Lexis Nexis account and not within the SmartSimple instance.<br />
<br />
===Returning information from Watch List===<br />
The syntax for configuring the Watch list check is as follows:<br />
<br />
:: <span style="font-size: medium;">'''@ssGet(ServiceName,entity;;firstname;;lastname;;search options;;roleslist;;meta template;;line template)@'''</span><br />
The ServiceName is dependent on which third party service you are utilizing:<br />
<br />
: CSI Web: WatchList<br />
: Lexis Nexis: LexisNexis<br />
The 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.<br />
<br />
<pre style="padding-left: 30px;">@parent.client.xml.Board of Directors XML.boardDirectors.boardDirectorsAdd[#$ssGet(WatchList,company;;owner;;;;3;;Grant Seeker,Executive Director,Board Member;;<br />
<strong>Board Member Search:</strong> ~Name.nodevalue~<br />Matches Found: [[recordcount]];;</pre><br />
{| class="xmlSectionTable"<br />
|-<br />
! class="xmlHead"|Result<br />
! class="xmlHead"|ID<br />
! class="xmlHead"|Name<br />
! class="xmlHead"|Type<br />
! class="xmlHead"|Alias<br />
! class="xmlHead"|Details<br />
! class="xmlHead"|Score<br />
|- id="matchfound"<br />
| class="xmlCell"|[[index]]<br />
| class="xmlCell"|[[id]]<br />
| class="xmlCell"|[[name]]<br />
| class="xmlCell"|[[type]]<br />
||[[alias]]<br />
||[[details]]<br />
| class="xmlCell"|[[score]]<br />
|}<br />
<pre>;;unparsedname=~Name.nodevalue~)$#]@<br /><br /><br />
@ssGet(LexisNexis,people;;@firstname@;;@lastname@;;1;;;;<strong>Applicant Search:</strong> @firstname@ @lastname@<br />Matches Found: [[recordcount]];;</pre><br />
{| class="xmlSectionTable"<br />
|-<br />
! class="xmlHead"|Result<br />
! class="xmlHead"|ID<br />
! class="xmlHead"|Name<br />
! class="xmlHead"|Type<br />
! class="xmlHead"|Alias<br />
! class="xmlHead"|Details<br />
! class="xmlHead"|Score<br />
||[[alias]]<br />
||[[details]]<br />
| class="xmlCell"|[[score]]<br />
|}<br />
<pre>;;)@[[index]][[id]][[name]][[type]]<br />
<br />
</pre><br />
<br />
<br />
==Configuration - U.S. Census Online Database==<br />
@ssGet(FFD,FIPS;;@address@ @city@ @state@)@<br /><br />
@ssGet(FFD,Profile;;year;;Address or FIPS code;;level;;<nowiki>[[template]]</nowiki>)@<br /><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>)'''<br />
<br />
==Configuration - [[:Category:Janus|Janus]]==<br />
@ssGet(JANUS,modelname)@<br />
<br />
==See Also==<br />
:* [[Census Integration]]<br />
:* [[OFAC, IRS, CRA Checks|OFAC, IRS and CRA Checks]]<br />
:* [[:Category:Janus|Janus, SmartSimple’s Machine Learning tool]]<br />
[[Category:Integration]][[Category:External Data Source]][[Category:Variables]]<br />
<!-- OFAC OFACS ofac ofacs OFACs --></div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SsGet&diff=37181SsGet2019-10-16T20:55:49Z<p>DEardley: /* Configuration - Returning information from Janus */</p>
<hr />
<div>=General Overview=<br />
The ''ssGet'' variable is used to extract information from a number of databases. These include:<br />
<br />
* The [[OFAC, IRS, CRA Checks|OFAC (Office of Foreign Assets Control) database]]<br />
* Watch List Integration third party providers<br />
* U.S. [[Census Integration|census data]]<br />
* [[:Category:Janus|Janus]], SmartSimple’s Machine Learning tool.<br />
<br />
<br />
The syntax for the ''ssGet'' variable varies by the database from which information is being returned.<br />
<br />
==Configuration - Office of Foreign Assets Control (OFAC)==<br />
{{Template:ProfessionalServices}}<br />
<br />
On-request checks can be made against the OFAC's online database within SmartSimple. For example, on an organization [[profile]], a [[Web_Page_View_Field]] can be configured that exposes the following check results:<br />
<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.<br />
The syntax for configuring the OFAC check is as follows:<br />
<br />
: <span style="font-size: medium;">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</span><br />
===Settings Explained - Office of Foreign Assets Control (OFAC)===<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Entity<br />
||accepts "people", "company" or "all"<br />
|-<br />
||firstname<br />
||an individual's first name or company name<br />
|-<br />
||lastname<br />
||an individual's last name (will be ignored if entity is "company" or "all")<br />
|-<br />
||search options<br />
||accepts "1", "2" or "3"<br />
* 1 - search current object only (when "entity" is set to "people" or "company")<br />
* 2 - search people underneath (when "entity" is set to "company" only)<br />
* 3 - search current object and people underneath (when "entity" is set to "company" only)<br />
<br />
|-<br />
||rolelist<br />
||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).<br />
|-<br />
||meta template<br />
||Template of how "header" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[entity]]</nowiki>'' - search type<br />
* ''<nowiki>[[name]]</nowiki>'' - name of search result<br />
* ''<nowiki>[[recordcount]]</nowiki>'' - number of records returned by OFAC search<br />
* ''<nowiki>[[now]]</nowiki>'' - Current date<br />
''<nowiki>Example: "Search type : [[entity]] , Search for : [[name]], Records returned : [[recordcount]], Date :[[now]]"</nowiki>''<br />
<br />
|-<br />
||line template<br />
||Template of how "body" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[index]]</nowiki>'' - index number<br />
* ''<nowiki>[[id]]</nowiki>'' - OFAC ID for result<br />
* ''<nowiki>[[name]]</nowiki>'' - OFAC name for result<br />
* ''<nowiki>[[type]]</nowiki>'' - OFAC type for result<br />
* ''<nowiki>[[alias]]</nowiki>'' - other aliases used<br />
* ''<nowiki>[[details]]</nowiki>'' - returns OFAC designation for entity returned, including date updated in OFAC database<br />
* ''<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''.<br />
<br />
|}<br />
<br />
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 content of the [[Web_Page_View_Field]] may be configured simiarly to the example shown below:<br />
<br />
: [[Image:OFAC WPV.png|link=|800px]]<br />
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.<br />
<br />
<br />
<br />
==Configuration - Watch List Scanning==<br />
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.<br />
<br />
In Global Settings, under the Integrations tab, you will locate the Watch List Settings.<br />
<br />
The Watch List Settings provide the ability to enter your billing id and password for the third party service you are utilizing. <br />
<br />
<br />When utilizing CSI Web, there are settings to define the watch list(s) you wish to search against, and the scan threshold, which will dictate only being shown results that match or exceed the percentage match threshold.<br />
<br />
The list of supported third party services with CSI Web includes: <br />
<br />
* U.S. Bureau Of Industry and Security<br />
* Department of State - Bureau of International Security & *Nonproliferation list<br />
* Department of State - Defense Trade Controls Debarred Parties list<br />
* International Criminal Police Organization (INTERPOL)<br />
* Politically Exposed Persons, CIA Foreign Officials<br />
* Office of Inspector General<br />
* Excluded Parties List System provided by the General Services Administration (GSA)<br />
* Financial Crimes Enforcement Network<br />
* FinCEN Money Services Business<br />
* World Bank Ineligible Firms<br />
* Terrorist Exclusion List<br />
* FBI Most Wanted Fugitives<br />
<br />
<br />
When utilizing Lexis Nexis, the settings for which watch list services will be included in each scan, along with threshold settings, will be managed within your Lexis Nexis account and not within the SmartSimple instance.<br />
<br />
==Configuration - U.S. Census Online Database==<br />
@ssGet(FFD,FIPS;;@address@ @city@ @state@)@<br /><br />
@ssGet(FFD,Profile;;year;;Address or FIPS code;;level;;<nowiki>[[template]]</nowiki>)@<br /><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>)'''<br />
<br />
==Configuration - [[:Category:Janus|Janus]]==<br />
@ssGet(JANUS,modelname)@<br />
<br />
==See Also==<br />
:* [[Census Integration]]<br />
:* [[OFAC, IRS, CRA Checks|OFAC, IRS and CRA Checks]]<br />
:* [[:Category:Janus|Janus, SmartSimple’s Machine Learning tool]]<br />
[[Category:Integration]][[Category:External Data Source]][[Category:Variables]]<br />
<!-- OFAC OFACS ofac ofacs OFACs --></div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SsGet&diff=37180SsGet2019-10-16T20:55:35Z<p>DEardley: /* Configuration - Returning information from U.S. Census database */</p>
<hr />
<div>=General Overview=<br />
The ''ssGet'' variable is used to extract information from a number of databases. These include:<br />
<br />
* The [[OFAC, IRS, CRA Checks|OFAC (Office of Foreign Assets Control) database]]<br />
* Watch List Integration third party providers<br />
* U.S. [[Census Integration|census data]]<br />
* [[:Category:Janus|Janus]], SmartSimple’s Machine Learning tool.<br />
<br />
<br />
The syntax for the ''ssGet'' variable varies by the database from which information is being returned.<br />
<br />
==Configuration - Office of Foreign Assets Control (OFAC)==<br />
{{Template:ProfessionalServices}}<br />
<br />
On-request checks can be made against the OFAC's online database within SmartSimple. For example, on an organization [[profile]], a [[Web_Page_View_Field]] can be configured that exposes the following check results:<br />
<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.<br />
The syntax for configuring the OFAC check is as follows:<br />
<br />
: <span style="font-size: medium;">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</span><br />
===Settings Explained - Office of Foreign Assets Control (OFAC)===<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Entity<br />
||accepts "people", "company" or "all"<br />
|-<br />
||firstname<br />
||an individual's first name or company name<br />
|-<br />
||lastname<br />
||an individual's last name (will be ignored if entity is "company" or "all")<br />
|-<br />
||search options<br />
||accepts "1", "2" or "3"<br />
* 1 - search current object only (when "entity" is set to "people" or "company")<br />
* 2 - search people underneath (when "entity" is set to "company" only)<br />
* 3 - search current object and people underneath (when "entity" is set to "company" only)<br />
<br />
|-<br />
||rolelist<br />
||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).<br />
|-<br />
||meta template<br />
||Template of how "header" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[entity]]</nowiki>'' - search type<br />
* ''<nowiki>[[name]]</nowiki>'' - name of search result<br />
* ''<nowiki>[[recordcount]]</nowiki>'' - number of records returned by OFAC search<br />
* ''<nowiki>[[now]]</nowiki>'' - Current date<br />
''<nowiki>Example: "Search type : [[entity]] , Search for : [[name]], Records returned : [[recordcount]], Date :[[now]]"</nowiki>''<br />
<br />
|-<br />
||line template<br />
||Template of how "body" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[index]]</nowiki>'' - index number<br />
* ''<nowiki>[[id]]</nowiki>'' - OFAC ID for result<br />
* ''<nowiki>[[name]]</nowiki>'' - OFAC name for result<br />
* ''<nowiki>[[type]]</nowiki>'' - OFAC type for result<br />
* ''<nowiki>[[alias]]</nowiki>'' - other aliases used<br />
* ''<nowiki>[[details]]</nowiki>'' - returns OFAC designation for entity returned, including date updated in OFAC database<br />
* ''<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''.<br />
<br />
|}<br />
<br />
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 content of the [[Web_Page_View_Field]] may be configured simiarly to the example shown below:<br />
<br />
: [[Image:OFAC WPV.png|link=|800px]]<br />
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.<br />
<br />
<br />
<br />
==Configuration - Watch List Scanning==<br />
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.<br />
<br />
In Global Settings, under the Integrations tab, you will locate the Watch List Settings.<br />
<br />
The Watch List Settings provide the ability to enter your billing id and password for the third party service you are utilizing. <br />
<br />
<br />When utilizing CSI Web, there are settings to define the watch list(s) you wish to search against, and the scan threshold, which will dictate only being shown results that match or exceed the percentage match threshold.<br />
<br />
The list of supported third party services with CSI Web includes: <br />
<br />
* U.S. Bureau Of Industry and Security<br />
* Department of State - Bureau of International Security & *Nonproliferation list<br />
* Department of State - Defense Trade Controls Debarred Parties list<br />
* International Criminal Police Organization (INTERPOL)<br />
* Politically Exposed Persons, CIA Foreign Officials<br />
* Office of Inspector General<br />
* Excluded Parties List System provided by the General Services Administration (GSA)<br />
* Financial Crimes Enforcement Network<br />
* FinCEN Money Services Business<br />
* World Bank Ineligible Firms<br />
* Terrorist Exclusion List<br />
* FBI Most Wanted Fugitives<br />
<br />
<br />
When utilizing Lexis Nexis, the settings for which watch list services will be included in each scan, along with threshold settings, will be managed within your Lexis Nexis account and not within the SmartSimple instance.<br />
<br />
==Configuration - U.S. Census Online Database==<br />
@ssGet(FFD,FIPS;;@address@ @city@ @state@)@<br /><br />
@ssGet(FFD,Profile;;year;;Address or FIPS code;;level;;<nowiki>[[template]]</nowiki>)@<br /><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>)'''<br />
<br />
==Configuration - Returning information from [[:Category:Janus|Janus]]==<br />
@ssGet(JANUS,modelname)@<br />
<br />
==See Also==<br />
:* [[Census Integration]]<br />
:* [[OFAC, IRS, CRA Checks|OFAC, IRS and CRA Checks]]<br />
:* [[:Category:Janus|Janus, SmartSimple’s Machine Learning tool]]<br />
[[Category:Integration]][[Category:External Data Source]][[Category:Variables]]<br />
<!-- OFAC OFACS ofac ofacs OFACs --></div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SsGet&diff=37179SsGet2019-10-16T20:54:55Z<p>DEardley: </p>
<hr />
<div>=General Overview=<br />
The ''ssGet'' variable is used to extract information from a number of databases. These include:<br />
<br />
* The [[OFAC, IRS, CRA Checks|OFAC (Office of Foreign Assets Control) database]]<br />
* Watch List Integration third party providers<br />
* U.S. [[Census Integration|census data]]<br />
* [[:Category:Janus|Janus]], SmartSimple’s Machine Learning tool.<br />
<br />
<br />
The syntax for the ''ssGet'' variable varies by the database from which information is being returned.<br />
<br />
==Configuration - Office of Foreign Assets Control (OFAC)==<br />
{{Template:ProfessionalServices}}<br />
<br />
On-request checks can be made against the OFAC's online database within SmartSimple. For example, on an organization [[profile]], a [[Web_Page_View_Field]] can be configured that exposes the following check results:<br />
<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.<br />
The syntax for configuring the OFAC check is as follows:<br />
<br />
: <span style="font-size: medium;">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</span><br />
===Settings Explained - Office of Foreign Assets Control (OFAC)===<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Entity<br />
||accepts "people", "company" or "all"<br />
|-<br />
||firstname<br />
||an individual's first name or company name<br />
|-<br />
||lastname<br />
||an individual's last name (will be ignored if entity is "company" or "all")<br />
|-<br />
||search options<br />
||accepts "1", "2" or "3"<br />
* 1 - search current object only (when "entity" is set to "people" or "company")<br />
* 2 - search people underneath (when "entity" is set to "company" only)<br />
* 3 - search current object and people underneath (when "entity" is set to "company" only)<br />
<br />
|-<br />
||rolelist<br />
||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).<br />
|-<br />
||meta template<br />
||Template of how "header" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[entity]]</nowiki>'' - search type<br />
* ''<nowiki>[[name]]</nowiki>'' - name of search result<br />
* ''<nowiki>[[recordcount]]</nowiki>'' - number of records returned by OFAC search<br />
* ''<nowiki>[[now]]</nowiki>'' - Current date<br />
''<nowiki>Example: "Search type : [[entity]] , Search for : [[name]], Records returned : [[recordcount]], Date :[[now]]"</nowiki>''<br />
<br />
|-<br />
||line template<br />
||Template of how "body" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[index]]</nowiki>'' - index number<br />
* ''<nowiki>[[id]]</nowiki>'' - OFAC ID for result<br />
* ''<nowiki>[[name]]</nowiki>'' - OFAC name for result<br />
* ''<nowiki>[[type]]</nowiki>'' - OFAC type for result<br />
* ''<nowiki>[[alias]]</nowiki>'' - other aliases used<br />
* ''<nowiki>[[details]]</nowiki>'' - returns OFAC designation for entity returned, including date updated in OFAC database<br />
* ''<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''.<br />
<br />
|}<br />
<br />
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 content of the [[Web_Page_View_Field]] may be configured simiarly to the example shown below:<br />
<br />
: [[Image:OFAC WPV.png|link=|800px]]<br />
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.<br />
<br />
<br />
<br />
==Configuration - Watch List Scanning==<br />
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.<br />
<br />
In Global Settings, under the Integrations tab, you will locate the Watch List Settings.<br />
<br />
The Watch List Settings provide the ability to enter your billing id and password for the third party service you are utilizing. <br />
<br />
<br />When utilizing CSI Web, there are settings to define the watch list(s) you wish to search against, and the scan threshold, which will dictate only being shown results that match or exceed the percentage match threshold.<br />
<br />
The list of supported third party services with CSI Web includes: <br />
<br />
* U.S. Bureau Of Industry and Security<br />
* Department of State - Bureau of International Security & *Nonproliferation list<br />
* Department of State - Defense Trade Controls Debarred Parties list<br />
* International Criminal Police Organization (INTERPOL)<br />
* Politically Exposed Persons, CIA Foreign Officials<br />
* Office of Inspector General<br />
* Excluded Parties List System provided by the General Services Administration (GSA)<br />
* Financial Crimes Enforcement Network<br />
* FinCEN Money Services Business<br />
* World Bank Ineligible Firms<br />
* Terrorist Exclusion List<br />
* FBI Most Wanted Fugitives<br />
<br />
<br />
When utilizing Lexis Nexis, the settings for which watch list services will be included in each scan, along with threshold settings, will be managed within your Lexis Nexis account and not within the SmartSimple instance.<br />
<br />
==Configuration - Returning information from U.S. Census database==<br />
@ssGet(FFD,FIPS;;@address@ @city@ @state@)@<br /><br />
@ssGet(FFD,Profile;;year;;Address or FIPS code;;level;;<nowiki>[[template]]</nowiki>)@<br /><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>)'''<br />
<br />
==Configuration - Returning information from [[:Category:Janus|Janus]]==<br />
@ssGet(JANUS,modelname)@<br />
<br />
==See Also==<br />
:* [[Census Integration]]<br />
:* [[OFAC, IRS, CRA Checks|OFAC, IRS and CRA Checks]]<br />
:* [[:Category:Janus|Janus, SmartSimple’s Machine Learning tool]]<br />
[[Category:Integration]][[Category:External Data Source]][[Category:Variables]]<br />
<!-- OFAC OFACS ofac ofacs OFACs --></div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SsGet&diff=37178SsGet2019-10-16T20:35:31Z<p>DEardley: </p>
<hr />
<div>=ssGet Overview=<br />
The ''ssGet'' variable is used to extract information from a number of databases. These include:<br />
<br />
* The [[OFAC, IRS, CRA Checks|OFAC (Office of Foreign Assets Control) database]]<br />
* Watch List Integration third party providers<br />
* U.S. [[Census Integration|census data]]<br />
* [[:Category:Janus|Janus]], SmartSimple’s Machine Learning tool.<br />
<br />
<br />
The syntax for the ''ssGet'' variable varies by the database from which information is being returned.<br />
<br />
==Configuration - Office of Foreign Assets Control (OFAC)==<br />
{{ProfessionalServices}}<br />
<br />
On-request checks can be made against the OFAC's online database within SmartSimple. For example, on an organization [[profile]], a [[Web_Page_View_Field]] can be configured that exposes the following check results:<br />
<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.<br />
The syntax for configuring the OFAC check is as follows:<br />
<br />
: <span style="font-size: medium;">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</span><br />
===Settings Explained - Office of Foreign Assets Control (OFAC)===<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Entity<br />
||accepts "people", "company" or "all"<br />
|-<br />
||firstname<br />
||an individual's first name or company name<br />
|-<br />
||lastname<br />
||an individual's last name (will be ignored if entity is "company" or "all")<br />
|-<br />
||search options<br />
||accepts "1", "2" or "3"<br />
* 1 - search current object only (when "entity" is set to "people" or "company")<br />
* 2 - search people underneath (when "entity" is set to "company" only)<br />
* 3 - search current object and people underneath (when "entity" is set to "company" only)<br />
<br />
|-<br />
||rolelist<br />
||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).<br />
|-<br />
||meta template<br />
||Template of how "header" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[entity]]</nowiki>'' - search type<br />
* ''<nowiki>[[name]]</nowiki>'' - name of search result<br />
* ''<nowiki>[[recordcount]]</nowiki>'' - number of records returned by OFAC search<br />
* ''<nowiki>[[now]]</nowiki>'' - Current date<br />
''<nowiki>Example: "Search type : [[entity]] , Search for : [[name]], Records returned : [[recordcount]], Date :[[now]]"</nowiki>''<br />
<br />
|-<br />
||line template<br />
||Template of how "body" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[index]]</nowiki>'' - index number<br />
* ''<nowiki>[[id]]</nowiki>'' - OFAC ID for result<br />
* ''<nowiki>[[name]]</nowiki>'' - OFAC name for result<br />
* ''<nowiki>[[type]]</nowiki>'' - OFAC type for result<br />
* ''<nowiki>[[alias]]</nowiki>'' - other aliases used<br />
* ''<nowiki>[[details]]</nowiki>'' - returns OFAC designation for entity returned, including date updated in OFAC database<br />
* ''<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''.<br />
<br />
|}<br />
<br />
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 content of the [[Web_Page_View_Field]] may be configured simiarly to the example shown below:<br />
<br />
: [[Image:OFAC WPV.png|link=|800px]]<br />
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.<br />
<br />
<br />
{{Template:Watchlist}}<br />
<br />
<br />
<br />
==Configuration - Returning information from U.S. Census database==<br />
@ssGet(FFD,FIPS;;@address@ @city@ @state@)@<br /><br />
@ssGet(FFD,Profile;;year;;Address or FIPS code;;level;;<nowiki>[[template]]</nowiki>)@<br /><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>)'''<br />
<br />
==Configuration - Returning information from [[:Category:Janus|Janus]]==<br />
@ssGet(JANUS,modelname)@<br />
<br />
==See Also==<br />
:* [[Census Integration]]<br />
:* [[OFAC, IRS, CRA Checks|OFAC, IRS and CRA Checks]]<br />
:* [[:Category:Janus|Janus, SmartSimple’s Machine Learning tool]]<br />
[[Category:Integration]][[Category:External Data Source]][[Category:Variables]]<br />
<!-- OFAC OFACS ofac ofacs OFACs --></div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SsGet&diff=37177SsGet2019-10-16T20:32:56Z<p>DEardley: </p>
<hr />
<div>=ssGet Overview=<br />
The ''ssGet'' variable is used to extract information from a number of databases. These include:<br />
<br />
* The [[OFAC, IRS, CRA Checks|OFAC (Office of Foreign Assets Control) database]]<br />
* Watch List Integration third party providers<br />
* U.S. [[Census Integration|census data]]<br />
* [[:Category:Janus|Janus]], SmartSimple’s Machine Learning tool.<br />
<br />
<br />
The syntax for the ''ssGet'' variable varies by the database from which information is being returned.<br />
<br />
==Configuration - Office of Foreign Assets Control (OFAC)==<br />
{{ProfessionalServices}}<br />
<br />
On-request checks can be made against the OFAC's online database within SmartSimple. For example, on an organization [[profile]], a [[Web_Page_View_Field]] can be configured that exposes the following check results: <br />
<br />
: [[Image:RunOFACCheck2.png|link=|600px]]<br /><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.<br />
The syntax for configuring the OFAC check is as follows:<br />
<br />
: <span style="font-size: medium;">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</span><br />
===Settings Explained - Office of Foreign Assets Control (OFAC)===<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Entity<br />
||accepts "people", "company" or "all"<br />
|-<br />
||firstname<br />
||an individual's first name or company name<br />
|-<br />
||lastname<br />
||an individual's last name (will be ignored if entity is "company" or "all")<br />
|-<br />
||search options<br />
||accepts "1", "2" or "3"<br />
* 1 - search current object only (when "entity" is set to "people" or "company")<br />
* 2 - search people underneath (when "entity" is set to "company" only)<br />
* 3 - search current object and people underneath (when "entity" is set to "company" only)<br />
<br />
|-<br />
||rolelist<br />
||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).<br />
|-<br />
||meta template<br />
||Template of how "header" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[entity]]</nowiki>'' - search type<br />
* ''<nowiki>[[name]]</nowiki>'' - name of search result<br />
* ''<nowiki>[[recordcount]]</nowiki>'' - number of records returned by OFAC search<br />
* ''<nowiki>[[now]]</nowiki>'' - Current date<br />
''<nowiki>Example: "Search type : [[entity]] , Search for : [[name]], Records returned : [[recordcount]], Date :[[now]]"</nowiki>''<br />
<br />
|-<br />
||line template<br />
||Template of how "body" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[index]]</nowiki>'' - index number<br />
* ''<nowiki>[[id]]</nowiki>'' - OFAC ID for result<br />
* ''<nowiki>[[name]]</nowiki>'' - OFAC name for result<br />
* ''<nowiki>[[type]]</nowiki>'' - OFAC type for result<br />
* ''<nowiki>[[alias]]</nowiki>'' - other aliases used<br />
* ''<nowiki>[[details]]</nowiki>'' - returns OFAC designation for entity returned, including date updated in OFAC database<br />
* ''<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''.<br />
<br />
|}<br />
<br />
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 content of the [[Web_Page_View_Field]] may be configured simiarly to the example shown below:<br />
<br />
: [[Image:OFAC WPV.png|link=|800px]]<br />
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.<br />
<br />
<br />
{{Template:Watchlist}}<br />
<br />
<br />
<br />
==Returning information from the online U.S. Census database==<br />
@ssGet(FFD,FIPS;;@address@ @city@ @state@)@<br /><br />
@ssGet(FFD,Profile;;year;;Address or FIPS code;;level;;<nowiki>[[template]]</nowiki>)@<br /><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>)'''<br />
<br />
==Returning information from [[:Category:Janus|Janus]]==<br />
@ssGet(JANUS,modelname)@<br />
<br />
==See Also==<br />
:* [[Census Integration]]<br />
:* [[OFAC, IRS, CRA Checks|OFAC, IRS and CRA Checks]]<br />
:* [[:Category:Janus|Janus, SmartSimple’s Machine Learning tool]]<br />
[[Category:Integration]][[Category:External Data Source]][[Category:Variables]]<br />
<!-- OFAC OFACS ofac ofacs OFACs --></div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SsGet&diff=37176SsGet2019-10-16T20:31:48Z<p>DEardley: </p>
<hr />
<div>=ssGet Overview=<br />
The ''ssGet'' variable is used to extract information from a number of databases. These include:<br />
<br />
* The [[OFAC, IRS, CRA Checks|OFAC (Office of Foreign Assets Control) database]]<br />
* Watch List Integration third party providers<br />
* U.S. [[Census Integration|census data]]<br />
* [[:Category:Janus|Janus]], SmartSimple’s Machine Learning tool.<br />
<br />
<br />
The syntax for the ''ssGet'' variable varies by the database from which information is being returned.<br />
<br />
==Configuration - Office of Foreign Assets Control (OFAC)==<br />
{{ProfessionalServices}}<br />
<br />
On-request checks can be made against the OFAC's online database within SmartSimple. For example, on an organization [[profile]], a [[Web_Page_View_Field]] can be configured that exposes the following check results: <br /><br />
[[Image:RunOFACCheck2.png|link=|600px]]<br /><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.<br />
<br />
The syntax for configuring the OFAC check is as follows:<br />
<br />
: <span style="font-size: medium;">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</span><br />
===Settings Explained - Office of Foreign Assets Control (OFAC)===<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Entity<br />
||accepts "people", "company" or "all"<br />
|-<br />
||firstname<br />
||an individual's first name or company name<br />
|-<br />
||lastname<br />
||an individual's last name (will be ignored if entity is "company" or "all")<br />
|-<br />
||search options<br />
||accepts "1", "2" or "3"<br />
* 1 - search current object only (when "entity" is set to "people" or "company")<br />
* 2 - search people underneath (when "entity" is set to "company" only)<br />
* 3 - search current object and people underneath (when "entity" is set to "company" only)<br />
<br />
|-<br />
||rolelist<br />
||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).<br />
|-<br />
||meta template<br />
||Template of how "header" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[entity]]</nowiki>'' - search type<br />
* ''<nowiki>[[name]]</nowiki>'' - name of search result<br />
* ''<nowiki>[[recordcount]]</nowiki>'' - number of records returned by OFAC search<br />
* ''<nowiki>[[now]]</nowiki>'' - Current date<br />
''<nowiki>Example: "Search type : [[entity]] , Search for : [[name]], Records returned : [[recordcount]], Date :[[now]]"</nowiki>''<br />
<br />
|-<br />
||line template<br />
||Template of how "body" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[index]]</nowiki>'' - index number<br />
* ''<nowiki>[[id]]</nowiki>'' - OFAC ID for result<br />
* ''<nowiki>[[name]]</nowiki>'' - OFAC name for result<br />
* ''<nowiki>[[type]]</nowiki>'' - OFAC type for result<br />
* ''<nowiki>[[alias]]</nowiki>'' - other aliases used<br />
* ''<nowiki>[[details]]</nowiki>'' - returns OFAC designation for entity returned, including date updated in OFAC database<br />
* ''<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''.<br />
<br />
|}<br />
<br />
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 content of the [[Web_Page_View_Field]] may be configured simiarly to the example shown below:<br />
<br />
: [[Image:OFAC WPV.png|link=|800px]]<br />
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.<br />
<br />
<br />
{{Template:Watchlist}}<br />
<br />
<br />
<br />
==Returning information from the online U.S. Census database==<br />
@ssGet(FFD,FIPS;;@address@ @city@ @state@)@<br /><br />
@ssGet(FFD,Profile;;year;;Address or FIPS code;;level;;<nowiki>[[template]]</nowiki>)@<br /><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>)'''<br />
<br />
==Returning information from [[:Category:Janus|Janus]]==<br />
@ssGet(JANUS,modelname)@<br />
<br />
==See Also==<br />
:* [[Census Integration]]<br />
:* [[OFAC, IRS, CRA Checks|OFAC, IRS and CRA Checks]]<br />
:* [[:Category:Janus|Janus, SmartSimple’s Machine Learning tool]]<br />
[[Category:Integration]][[Category:External Data Source]][[Category:Variables]]<br />
<!-- OFAC OFACS ofac ofacs OFACs --></div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SsGet&diff=37175SsGet2019-10-16T20:29:57Z<p>DEardley: </p>
<hr />
<div>=ssGet Overview=<br />
The ''ssGet'' variable is used to extract information from a number of databases. These include:<br />
<br />
* The [[OFAC, IRS, CRA Checks|OFAC (Office of Foreign Assets Control) database]]<br />
* Watch List Integration third party providers<br />
* U.S. [[Census Integration|census data]]<br />
* [[:Category:Janus|Janus]], SmartSimple’s Machine Learning tool.<br />
<br />
<br />
The syntax for the ''ssGet'' variable varies by the database from which information is being returned.<br />
<br />
==Configuration - Office of Foreign Assets Control (OFAC)==<br />
{{ProfessionalServices}}<br />
<br />
On-request checks can be made against the OFAC's online database within SmartSimple. For example, on an organization [[profile]], a web page view field can be configured that exposes the following check results: <br /><br />
[[Image:RunOFACCheck2.png|link=|600px]]<br /><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.<br />
<br />
The syntax for configuring the OFAC check is as follows:<br />
<br />
: <span style="font-size: medium;">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</span><br />
===Settings Explained - Office of Foreign Assets Control (OFAC)===<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Entity<br />
||accepts "people", "company" or "all"<br />
|-<br />
||firstname<br />
||an individual's first name or company name<br />
|-<br />
||lastname<br />
||an individual's last name (will be ignored if entity is "company" or "all")<br />
|-<br />
||search options<br />
||accepts "1", "2" or "3"<br />
* 1 - search current object only (when "entity" is set to "people" or "company")<br />
* 2 - search people underneath (when "entity" is set to "company" only)<br />
* 3 - search current object and people underneath (when "entity" is set to "company" only)<br />
<br />
|-<br />
||rolelist<br />
||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).<br />
|-<br />
||meta template<br />
||Template of how "header" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[entity]]</nowiki>'' - search type<br />
* ''<nowiki>[[name]]</nowiki>'' - name of search result<br />
* ''<nowiki>[[recordcount]]</nowiki>'' - number of records returned by OFAC search<br />
* ''<nowiki>[[now]]</nowiki>'' - Current date<br />
''<nowiki>Example: "Search type : [[entity]] , Search for : [[name]], Records returned : [[recordcount]], Date :[[now]]"</nowiki>''<br />
<br />
|-<br />
||line template<br />
||Template of how "body" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[index]]</nowiki>'' - index number<br />
* ''<nowiki>[[id]]</nowiki>'' - OFAC ID for result<br />
* ''<nowiki>[[name]]</nowiki>'' - OFAC name for result<br />
* ''<nowiki>[[type]]</nowiki>'' - OFAC type for result<br />
* ''<nowiki>[[alias]]</nowiki>'' - other aliases used<br />
* ''<nowiki>[[details]]</nowiki>'' - returns OFAC designation for entity returned, including date updated in OFAC database<br />
* ''<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''.<br />
<br />
|}<br />
<br />
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 content of the Web Page View may be configured simiarly to the example shown below:<br />
<br />
: [[Image:OFAC WPV.png|link=|800px]]<br />
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.<br />
<br />
<br />
{{Template:Watchlist}}<br />
<br />
<br />
<br />
==Returning information from the online U.S. Census database==<br />
@ssGet(FFD,FIPS;;@address@ @city@ @state@)@<br /><br />
@ssGet(FFD,Profile;;year;;Address or FIPS code;;level;;<nowiki>[[template]]</nowiki>)@<br /><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>)'''<br />
<br />
==Returning information from [[:Category:Janus|Janus]]==<br />
@ssGet(JANUS,modelname)@<br />
<br />
==See Also==<br />
:* [[Census Integration]]<br />
:* [[OFAC, IRS, CRA Checks|OFAC, IRS and CRA Checks]]<br />
:* [[:Category:Janus|Janus, SmartSimple’s Machine Learning tool]]<br />
[[Category:Integration]][[Category:External Data Source]][[Category:Variables]]<br />
<!-- OFAC OFACS ofac ofacs OFACs --></div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SsGet&diff=37174SsGet2019-10-16T20:29:09Z<p>DEardley: </p>
<hr />
<div>=ssGet Overview=<br />
The ''ssGet'' variable is used to extract information from a number of databases. These include:<br />
<br />
* The [[OFAC, IRS, CRA Checks|OFAC (Office of Foreign Assets Control) database]]<br />
* Watch List Integration third party providers<br />
* U.S. [[Census Integration|census data]]<br />
* [[:Category:Janus|Janus]], SmartSimple’s Machine Learning tool.<br />
<br />
<br />
The syntax for the ''ssGet'' variable varies by the database from which information is being returned.<br />
<br />
==Configuration - Office of Foreign Assets Control (OFAC)==<br />
{{ProfessionalServices}}<br />
<br />
On-request checks can be made against the OFAC's online database within SmartSimple. For example, on an organization [[profile]], a web page view field can be configured that exposes the following check results: <br /><br />
[[Image:RunOFACCheck2.png|link=|600px]]<br /><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.<br />
<br />
The syntax for configuring the OFAC check is as follows:<br />
<br />
: <span style="font-size: medium;">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</span><br />
==Settings Explained - Office of Foreign Assets Control (OFAC)==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Entity<br />
||accepts "people", "company" or "all"<br />
|-<br />
||firstname<br />
||an individual's first name or company name<br />
|-<br />
||lastname<br />
||an individual's last name (will be ignored if entity is "company" or "all")<br />
|-<br />
||search options<br />
||accepts "1", "2" or "3"<br />
* 1 - search current object only (when "entity" is set to "people" or "company")<br />
* 2 - search people underneath (when "entity" is set to "company" only)<br />
* 3 - search current object and people underneath (when "entity" is set to "company" only)<br />
<br />
|-<br />
||rolelist<br />
||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).<br />
|-<br />
||meta template<br />
||Template of how "header" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[entity]]</nowiki>'' - search type<br />
* ''<nowiki>[[name]]</nowiki>'' - name of search result<br />
* ''<nowiki>[[recordcount]]</nowiki>'' - number of records returned by OFAC search<br />
* ''<nowiki>[[now]]</nowiki>'' - Current date<br />
''<nowiki>Example: "Search type : [[entity]] , Search for : [[name]], Records returned : [[recordcount]], Date :[[now]]"</nowiki>''<br />
<br />
|-<br />
||line template<br />
||Template of how "body" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[index]]</nowiki>'' - index number<br />
* ''<nowiki>[[id]]</nowiki>'' - OFAC ID for result<br />
* ''<nowiki>[[name]]</nowiki>'' - OFAC name for result<br />
* ''<nowiki>[[type]]</nowiki>'' - OFAC type for result<br />
* ''<nowiki>[[alias]]</nowiki>'' - other aliases used<br />
* ''<nowiki>[[details]]</nowiki>'' - returns OFAC designation for entity returned, including date updated in OFAC database<br />
* ''<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''.<br />
<br />
|}<br />
<br />
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 content of the Web Page View may be configured simiarly to the example shown below:<br />
<br />
: [[Image:OFAC WPV.png|link=|800px]]<br />
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.<br />
<br />
<br />
{{Template:Watchlist}}<br />
<br />
<br />
<br />
==Returning information from the online U.S. Census database==<br />
@ssGet(FFD,FIPS;;@address@ @city@ @state@)@<br /><br />
@ssGet(FFD,Profile;;year;;Address or FIPS code;;level;;<nowiki>[[template]]</nowiki>)@<br /><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>)'''<br />
<br />
==Returning information from [[:Category:Janus|Janus]]==<br />
@ssGet(JANUS,modelname)@<br />
<br />
==See Also==<br />
:* [[Census Integration]]<br />
:* [[OFAC, IRS, CRA Checks|OFAC, IRS and CRA Checks]]<br />
:* [[:Category:Janus|Janus, SmartSimple’s Machine Learning tool]]<br />
[[Category:Integration]][[Category:External Data Source]][[Category:Variables]]<br />
<!-- OFAC OFACS ofac ofacs OFACs --></div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SsGet&diff=37173SsGet2019-10-16T20:28:22Z<p>DEardley: </p>
<hr />
<div>The ''ssGet'' variable is used to extract information from a number of databases. These include:<br />
<br />
* The [[OFAC, IRS, CRA Checks|OFAC (Office of Foreign Assets Control) database]]<br />
* Watch List Integration third party providers<br />
* U.S. [[Census Integration|census data]]<br />
* [[:Category:Janus|Janus]], SmartSimple’s Machine Learning tool.<br />
<br />
<br />
The syntax for the ''ssGet'' variable varies by the database from which information is being returned.<br />
<br />
==Configuration - Office of Foreign Assets Control (OFAC)==<br />
{{ProfessionalServices}}<br />
<br />
On-request checks can be made against the OFAC's online database within SmartSimple. For example, on an organization [[profile]], a web page view field can be configured that exposes the following check results: <br /><br />
[[Image:RunOFACCheck2.png|link=|600px]]<br /><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.<br />
<br />
The syntax for configuring the OFAC check is as follows:<br />
<br />
: <span style="font-size: medium;">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</span><br />
==Settings Explained - Office of Foreign Assets Control (OFAC)==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Entity<br />
||accepts "people", "company" or "all"<br />
|-<br />
||firstname<br />
||an individual's first name or company name<br />
|-<br />
||lastname<br />
||an individual's last name (will be ignored if entity is "company" or "all")<br />
|-<br />
||search options<br />
||accepts "1", "2" or "3"<br />
* 1 - search current object only (when "entity" is set to "people" or "company")<br />
* 2 - search people underneath (when "entity" is set to "company" only)<br />
* 3 - search current object and people underneath (when "entity" is set to "company" only)<br />
<br />
|-<br />
||rolelist<br />
||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).<br />
|-<br />
||meta template<br />
||Template of how "header" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[entity]]</nowiki>'' - search type<br />
* ''<nowiki>[[name]]</nowiki>'' - name of search result<br />
* ''<nowiki>[[recordcount]]</nowiki>'' - number of records returned by OFAC search<br />
* ''<nowiki>[[now]]</nowiki>'' - Current date<br />
''<nowiki>Example: "Search type : [[entity]] , Search for : [[name]], Records returned : [[recordcount]], Date :[[now]]"</nowiki>''<br />
<br />
|-<br />
||line template<br />
||Template of how "body" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[index]]</nowiki>'' - index number<br />
* ''<nowiki>[[id]]</nowiki>'' - OFAC ID for result<br />
* ''<nowiki>[[name]]</nowiki>'' - OFAC name for result<br />
* ''<nowiki>[[type]]</nowiki>'' - OFAC type for result<br />
* ''<nowiki>[[alias]]</nowiki>'' - other aliases used<br />
* ''<nowiki>[[details]]</nowiki>'' - returns OFAC designation for entity returned, including date updated in OFAC database<br />
* ''<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''.<br />
<br />
|}<br />
<br />
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 content of the Web Page View may be configured simiarly to the example shown below:<br />
<br />
: [[Image:OFAC WPV.png|link=|800px]]<br />
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.<br />
<br />
<br />
{{Template:Watchlist}}<br />
<br />
<br />
<br />
==Returning information from the online U.S. Census database==<br />
@ssGet(FFD,FIPS;;@address@ @city@ @state@)@<br /><br />
@ssGet(FFD,Profile;;year;;Address or FIPS code;;level;;<nowiki>[[template]]</nowiki>)@<br /><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>)'''<br />
<br />
==Returning information from [[:Category:Janus|Janus]]==<br />
@ssGet(JANUS,modelname)@<br />
<br />
==See Also==<br />
:* [[Census Integration]]<br />
:* [[OFAC, IRS, CRA Checks|OFAC, IRS and CRA Checks]]<br />
:* [[:Category:Janus|Janus, SmartSimple’s Machine Learning tool]]<br />
[[Category:Integration]][[Category:External Data Source]][[Category:Variables]]<br />
<!-- OFAC OFACS ofac ofacs OFACs --></div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SsGet&diff=37172SsGet2019-10-16T20:27:33Z<p>DEardley: </p>
<hr />
<div>__NOTOC__<br />
The ''ssGet'' variable is used to extract information from a number of databases. These include:<br />
<br />
* The [[OFAC, IRS, CRA Checks|OFAC (Office of Foreign Assets Control) database]]<br />
* Watch List Integration third party providers<br />
* U.S. [[Census Integration|census data]]<br />
* [[:Category:Janus|Janus]], SmartSimple’s Machine Learning tool.<br />
<br />
<br />
The syntax for the ''ssGet'' variable varies by the database from which information is being returned.<br />
<br />
==Configuration - Office of Foreign Assets Control (OFAC)==<br />
{{ProfessionalServices}}<br />
<br />
On-request checks can be made against the OFAC's online database within SmartSimple. For example, on an organization [[profile]], a web page view field can be configured that exposes the following check results: <br /><br />
[[Image:RunOFACCheck2.png|link=|600px]]<br /><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.<br />
<br />
The syntax for configuring the OFAC check is as follows:<br />
<br />
: <span style="font-size: medium;">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</span><br />
==Settings Explained - Office of Foreign Assets Control (OFAC)==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Entity<br />
||accepts "people", "company" or "all"<br />
|-<br />
||firstname<br />
||an individual's first name or company name<br />
|-<br />
||lastname<br />
||an individual's last name (will be ignored if entity is "company" or "all")<br />
|-<br />
||search options<br />
||accepts "1", "2" or "3"<br />
* 1 - search current object only (when "entity" is set to "people" or "company")<br />
* 2 - search people underneath (when "entity" is set to "company" only)<br />
* 3 - search current object and people underneath (when "entity" is set to "company" only)<br />
<br />
|-<br />
||rolelist<br />
||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).<br />
|-<br />
||meta template<br />
||Template of how "header" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[entity]]</nowiki>'' - search type<br />
* ''<nowiki>[[name]]</nowiki>'' - name of search result<br />
* ''<nowiki>[[recordcount]]</nowiki>'' - number of records returned by OFAC search<br />
* ''<nowiki>[[now]]</nowiki>'' - Current date<br />
''<nowiki>Example: "Search type : [[entity]] , Search for : [[name]], Records returned : [[recordcount]], Date :[[now]]"</nowiki>''<br />
<br />
|-<br />
||line template<br />
||Template of how "body" of results will be returned. Default template will be used if empty.<br />
variables that can be used include:<br />
* ''<nowiki>[[index]]</nowiki>'' - index number<br />
* ''<nowiki>[[id]]</nowiki>'' - OFAC ID for result<br />
* ''<nowiki>[[name]]</nowiki>'' - OFAC name for result<br />
* ''<nowiki>[[type]]</nowiki>'' - OFAC type for result<br />
* ''<nowiki>[[alias]]</nowiki>'' - other aliases used<br />
* ''<nowiki>[[details]]</nowiki>'' - returns OFAC designation for entity returned, including date updated in OFAC database<br />
* ''<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''.<br />
<br />
|}<br />
<br />
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 content of the Web Page View may be configured simiarly to the example shown below:<br />
<br />
: [[Image:OFAC WPV.png|link=|800px]]<br />
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.<br />
<br />
<br />
{{Template:Watchlist}}<br />
<br />
<br />
<br />
==Returning information from the online U.S. Census database==<br />
@ssGet(FFD,FIPS;;@address@ @city@ @state@)@<br /><br />
@ssGet(FFD,Profile;;year;;Address or FIPS code;;level;;<nowiki>[[template]]</nowiki>)@<br /><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>)'''<br />
<br />
==Returning information from [[:Category:Janus|Janus]]==<br />
@ssGet(JANUS,modelname)@<br />
<br />
==See Also==<br />
:* [[Census Integration]]<br />
:* [[OFAC, IRS, CRA Checks|OFAC, IRS and CRA Checks]]<br />
:* [[:Category:Janus|Janus, SmartSimple’s Machine Learning tool]]<br />
[[Category:Integration]][[Category:External Data Source]][[Category:Variables]]<br />
<!-- OFAC OFACS ofac ofacs OFACs --></div>DEardleyhttps://wiki.smartsimple.com/index.php?title=File:OFAC_WPV.png&diff=37171File:OFAC WPV.png2019-10-16T19:25:06Z<p>DEardley: </p>
<hr />
<div></div>DEardleyhttps://wiki.smartsimple.com/index.php?title=SsGet&diff=37170SsGet2019-10-16T19:20:57Z<p>DEardley: </p>
<hr />
<div>__NOTOC__<br />
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]], Watch List Integration third party providers, and [[:Category:Janus|Janus]], SmartSimple’s Machine Learning tool.<br />
<br />
The syntax for the ''ssGet'' variable varies by the database from which information is being returned.<br />
<br />
==Returning information from the Office of Foreign Assets Control (OFAC)==<br />
{{ProfessionalServices}}<br />
<br />
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 /><br />
[[Image:RunOFACCheck2.png|link=|600px]]<br /><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.<br />
<br />
The syntax for configuring the OFAC check is as follows:<br />
<br />
: <span style="font-size: medium;">'''@ssGet(OFAC,''entity'';;''firstname'';;''lastname'';;''search options'';;''roleslist'';;''meta template'';;''line template'')@'''</span><br />
The syntax components are as follows:<br />
<br />
* ''entity'': accepts "people", "company" or "all"<br />
* ''firstname'': an individual's first name or company name<br />
* ''lastname'': an individual's last name (will be ignored if entity is "company" or "all")<br />
* ''search options'': accepts "1", "2" or "3"<br />
** 1 - search current object only (when "entity" is set to "people" or "company")<br />
** 2 - search people underneath (when "entity" is set to "company" only)<br />
** 3 - search current object and people underneath (when "entity" is set to "company" only)<br />
* ''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).<br />
* ''meta template'': Template of how "header" of results will be returned. Default template will be used if empty<br />
<br />
: variables that can be used include:<br />
:* ''<nowiki>[[entity]]</nowiki>'' - search type<br />
:* ''<nowiki>[[name]]</nowiki>'' - name of search result<br />
:* ''<nowiki>[[recordcount]]</nowiki>'' - number of records returned by OFAC search<br />
:* ''<nowiki>[[now]]</nowiki>'' - Current date<br />
''<nowiki>Example: "Search type : [[entity]] , Search for : [[name]], Records returned : [[recordcount]], Date :[[now]]"</nowiki>''<br />
:* ''line template'': Template of how "body" of results will be returned. Default template will be used if empty<br />
:: variables that can be used include:<br />
::* ''<nowiki>[[index]]</nowiki>'' - index number<br />
::* ''<nowiki>[[id]]</nowiki>'' - OFAC ID for result<br />
::* ''<nowiki>[[name]]</nowiki>'' - OFAC name for result<br />
::* ''<nowiki>[[type]]</nowiki>'' - OFAC type for result<br />
::* ''<nowiki>[[alias]]</nowiki>'' - other aliases used<br />
::* ''<nowiki>[[details]]</nowiki>'' - returns OFAC designation for entity returned, including date updated in OFAC database<br />
::* ''<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''.<br />
''<nowiki>Example:[[index]][[id]][[name]][[type]][[details]][[score]]</nowiki>''<br />
<br />
The following is an example of the configuration of the above display:<br />
<br />
:: [[Image:OFACCheckWPVConfig.png|link=|600px]]<br />
:: '''''Text version here:'''''<br />
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;"><!--filename="OFAC Check Results @name@ @date(currentdate)@"--><br />
<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 the "Save to Server as PDF" button above"</div><br />
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;"><br /><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]]</pre><br />
:* ID: [[id]]<br />
:* Name: [[name]]<br />
:* Type: [[type]]<br />
:* Details: [[details]]<br />
:* Score: [[score]]<br />
<br />
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;">)@<br />
<br /><br />
<br /><br />
<br /><br />
Date/time check performed: <!--@sscalculation(DATE_FORMAT("@datetime(currentdate)@","%m/%d/%Y % %h:%i%p"))--> E.S.T.<br /><br />
Performed by: @me.fullname@<br /><br />
<br /><br />
</pre><br />
<br />
{{Template:Watchlist}}<br />
<br />
<br />
<br />
==Returning information from the online U.S. Census database==<br />
@ssGet(FFD,FIPS;;@address@ @city@ @state@)@<br /><br />
@ssGet(FFD,Profile;;year;;Address or FIPS code;;level;;<nowiki>[[template]]</nowiki>)@<br /><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>)'''<br />
<br />
==Returning information from [[:Category:Janus|Janus]]==<br />
@ssGet(JANUS,modelname)@<br />
<br />
==See Also==<br />
:* [[Census Integration]]<br />
:* [[OFAC, IRS, CRA Checks|OFAC, IRS and CRA Checks]]<br />
:* [[:Category:Janus|Janus, SmartSimple’s Machine Learning tool]]<br />
[[Category:Integration]][[Category:External Data Source]][[Category:Variables]]<br />
<!-- OFAC OFACS ofac ofacs OFACs --></div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Impact_Map&diff=37163Impact Map2019-10-09T15:46:17Z<p>DEardley: </p>
<hr />
<div>=Overview=<br />
The Impact Map is a feature that can be used to plot records from a UTA on a map interface to display locations from the UTA records.<br />
<br />
This feature provides a unique method for visualizing your data using geomapping functionality, commonly used for displaying locations of grant impact.<br />
<br />
In order to configure an Impact Map, you will need administrator access to the UTA that will be used for generating the locations on the map.<br />
<br />
[[File:Map_Sample.png|thumb|none|1000px|Sample Impact Map Display.]]<br />
<br />
=Configuration - Essentials=<br />
* Choose the UTA the map will be associated with based on the types of records you want to present on the map.<br />
* An Impact Map can be created using either Level 1 or Level 2 records in the UTA. <br />
** Level 1 records will be displayed on the Impact Map using the location of the organization (standard field: client) associated to the record.<br />
** Level 2 records may be displayed on the Impact Map using a unique address that will be defined using Geocode Field Mapping settings. See 'Configuration - Advanced' for additional steps that are required.<br />
* In order for records to be plotted on the map, the use of the standard fields 'Latitude' and 'Longitude' must be enabled on your records. Review your records' standard fields, and enable these fields if not completed previously.<br />
** Note: The values for Latitude and Longitude must be stored to the record by either saving the record or using the 'Retrieve Latitude/Longitude' workflow task type.<br />
* In the UTA Configuration Settings, navigate to the Level 2 tab and select the 'Impact Map Settings' link. <br />
** Create a new map using the (+) Create New Map button in the menu. Assign the map settings based on the available parameters listed in the 'Settings Explained' section below.<br />
** Once you have entered all of the settings for the map, save the map. <br />
** Click the 'Generate HTML and JSON files' button to create the required files that will be stored to your selected SmartFolder. The HTML file URL will be accessible in the Impact Map configuration page. This can be referenced for navigating to the map, and can be utilized in portal design by referencing the relative URL in a custom page or custom portal section (Example: /files/368847/f304276/11_impactmap.html).<br />
<br />
==Settings Explained==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Name<br />
||The name of the map you are creating.<br />
|-<br />
||Description<br />
||Used for storing additional detail about the map.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Status Filter<br />
||Filters the records being plotted on the map based on the record status.<br />
|-<br />
||Amount Field<br />
||The field that will be used in an aggregate sum displayed on the map (Grant Total: $###).<br />
|-<br />
||Zoom Level<br />
||The level of zoom defined for loading the page on the Zoom Center you select.<br />
|-<br />
||Zoom Center<br />
||The location on the map that the map will default in loading.<br />
|-<br />
||Auto Zoom<br />
||This option will automatically load the map zoomed in on the area where records exist. If selected, the Zoom Level and Zoom Center are not utilized.<br />
|-<br />
||Map Theme<br />
||The style of the map that will be displayed.<br />
|-<br />
||Marker URL<br />
||This can be utilized to reference an image file for use as the map markers in place of the default Google Maps marker. This is not required if you want to use the default marker.<br />
|-<br />
||Information Fields<br />
||Select the fields from the UTA record that you want displayed in the information box that will be displayed when selecting a marker on the map.<br />
|-<br />
||Information Template<br />
||This can be utilized if you plan to use a custom template for the Information Fields display on the map. This is not required.<br />
|-<br />
||[[KML]]<br />
||You can add references to KML files for your map so that KML overlays can be applied to the map. This is not required.<br />
|-<br />
||SmartFolder<br />
||You must select a SmartFolder where the map files will be stored to within your SmartSimple instance.<br />
|}<br />
<br />
==Map Theme Styles==<br />
Blue Water[[File:Blue_Water.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Facebook<br />
[[File:Facebook.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Light Grayscale<br />
[[File:Light_Grayscale.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Golden Brown<br />
[[File:Golden_Brown.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Retro<br />
[[File:Retro.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
=Configuration - Advanced=<br />
By creating a Level 2 Impact Map, you have the flexibility to present a unique address for your location, but also have the ability to present multiple locations for a single Level 1. For example, if you have a Level 1 Grant that occurs in multiple locations, you can create multiple location Level 2 activities to plot multiple points on the Impact Map.<br />
<br />
One approach for creating your Level 2 location activities is the use of an Advanced Data Table custom field on your Level 1 record which is mapped to create Level 2 records. With this approach, you can enter multiple locations in the Advanced Data Table field, and each will create a Level 2 record automatically. See [[Custom_Field_Type:_Special_-_Advanced_Data_Table]] for steps on Managing Level 2 / 3 Activities with a Section.<br />
<br />
When creating an Impact Map using Level 2 records, you will need to take several additional configuration steps that are not required for Level 1 record maps.<br />
<br />
* Ensure that the 'Latitude' and 'Longitude' standard fields are enabled on your Level 2 object in your UTA. Navigate to your Standard Fields list for your Level 2 object and save the 'Latitude' and 'Longitude' fields if they have not been enabled previously.<br />
* Create custom fields on your Level 2 object for storing the address that will be plotted on the Impact Map. These may include fields to capture Address 1, Address 2, City, State Country, Postal Code. You must separate each attribute into a distinct field.<br />
* Geocode Field Mapping must be established on your Level 2 object. The Geocode Field Mapping feature allows for the calculation of latitude and longitude based on addresses entered against level 2 custom fields.<br />
** Navigate to your UTA configuration settings, view the Level 2 object tab, and click on the the link labeled ''Geocode Field Mapping''.<br />
*** Define the Level 2 custom fields that will be used for each defined address component.<br />
[[File:L2AddressMapping1.png|thumb|none|800px|Address Mapping]]<br />
<br />
* In order for the Level 2 record to store the latitude and longitude for the location, the Level 2 record must be saved after the address details have been entered in the address custom fields. Alternatively, you may use a workflow on the Level 2 record that uses the 'Retrieve Latitude/Longitude' workflow task type. This workflow task will automatically calculate the latitude and longitude based on the custom field address values. The workflow must be triggered at a point in time after the address values have been entered in the Level 2 record.<br />
<br />
<br />
==See Also==<br />
* [[KML]]<br />
<br />
[[Category:Tools]]<br />
[[Category:Geocoding]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Impact_Map&diff=37162Impact Map2019-10-09T15:44:41Z<p>DEardley: </p>
<hr />
<div>=Overview=<br />
The Impact Map is a feature that can be used to plot records from a UTA on a map interface to display locations from the UTA records.<br />
<br />
This feature provides a unique method for visualizing your data using geomapping functionality, commonly used for displaying locations of grant impact.<br />
<br />
In order to configure an Impact Map, you will need administrator access to the UTA that will be used for generating the locations on the map.<br />
<br />
[[File:Map_Sample.png|thumb|none|1000px|Sample Impact Map Display.]]<br />
<br />
=Configuration - Essentials=<br />
* Choose the UTA the map will be associated with based on the types of records you want to present on the map.<br />
* An Impact Map can be created using either Level 1 or Level 2 records in the UTA. <br />
** Level 1 records will be displayed on the Impact Map using the location of the organization (standard field: client) associated to the record.<br />
** Level 2 records may be displayed on the Impact Map using a unique address that will be defined using Geocode Field Mapping settings. See 'Configuration - Advanced' for additional steps that are required.<br />
* In order for records to be plotted on the map, the use of the standard fields 'Latitude' and 'Longitude' must be enabled on your records. Review your records' standard fields, and enable these fields if not completed previously.<br />
** Note: The values for Latitude and Longitude must be stored to the record by either saving the record or using the 'Retrieve Latitude/Longitude' workflow task type.<br />
* In the UTA Configuration Settings, navigate to the Level 2 tab and select the 'Impact Map Settings' link. <br />
** Create a new map using the (+) Create New Map button in the menu. Assign the map settings based on the available parameters listed in the 'Settings Explained' section below.<br />
** Once you have entered all of the settings for the map, save the map. <br />
** Click the 'Generate HTML and JSON files' button to create the required files that will be stored to your selected SmartFolder. The HTML file URL will be accessible in the Impact Map configuration page. This can be referenced for navigating to the map, and can be utilized in portal design by referencing the relative URL in a custom page or custom portal section (Example: /files/368847/f304276/11_impactmap.html).<br />
<br />
==Settings Explained==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Name<br />
||The name of the map you are creating.<br />
|-<br />
||Description<br />
||Used for storing additional detail about the map.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Status Filter<br />
||Filters the records being plotted on the map based on the record status.<br />
|-<br />
||Amount Field<br />
||The field that will be used in an aggregate sum displayed on the map (Grant Total: $###).<br />
|-<br />
||Zoom Level<br />
||The level of zoom defined for loading the page on the Zoom Center you select.<br />
|-<br />
||Zoom Center<br />
||The location on the map that the map will default in loading.<br />
|-<br />
||Auto Zoom<br />
||This option will automatically load the map zoomed in on the area where records exist. If selected, the Zoom Level and Zoom Center are not utilized.<br />
|-<br />
||Map Theme<br />
||The style of the map that will be displayed.<br />
|-<br />
||Marker URL<br />
||This can be utilized to reference an image file for use as the map markers in place of the default Google Maps marker. This is not required if you want to use the default marker.<br />
|-<br />
||Information Fields<br />
||Select the fields from the UTA record that you want displayed in the information box that will be displayed when selecting a marker on the map.<br />
|-<br />
||Information Template<br />
||This can be utilized if you plan to use a custom template for the Information Fields display on the map. This is not required.<br />
|-<br />
||[[KML]]<br />
||You can add references to KML files for your map so that KML overlays can be applied to the map. This is not required.<br />
|-<br />
||SmartFolder<br />
||You must select a SmartFolder where the map files will be stored to within your SmartSimple instance.<br />
|}<br />
<br />
=Configuration - Advanced=<br />
By creating a Level 2 Impact Map, you have the flexibility to present a unique address for your location, but also have the ability to present multiple locations for a single Level 1. For example, if you have a Level 1 Grant that occurs in multiple locations, you can create multiple location Level 2 activities to plot multiple points on the Impact Map.<br />
<br />
One approach for creating your Level 2 location activities is the use of an Advanced Data Table custom field on your Level 1 record which is mapped to create Level 2 records. With this approach, you can enter multiple locations in the Advanced Data Table field, and each will create a Level 2 record automatically. See [[Custom_Field_Type:_Special_-_Advanced_Data_Table]] for steps on Managing Level 2 / 3 Activities with a Section.<br />
<br />
When creating an Impact Map using Level 2 records, you will need to take several additional configuration steps that are not required for Level 1 record maps.<br />
<br />
* Ensure that the 'Latitude' and 'Longitude' standard fields are enabled on your Level 2 object in your UTA. Navigate to your Standard Fields list for your Level 2 object and save the 'Latitude' and 'Longitude' fields if they have not been enabled previously.<br />
* Create custom fields on your Level 2 object for storing the address that will be plotted on the Impact Map. These may include fields to capture Address 1, Address 2, City, State Country, Postal Code. You must separate each attribute into a distinct field.<br />
* Geocode Field Mapping must be established on your Level 2 object. The Geocode Field Mapping feature allows for the calculation of latitude and longitude based on addresses entered against level 2 custom fields.<br />
** Navigate to your UTA configuration settings, view the Level 2 object tab, and click on the the link labeled ''Geocode Field Mapping''.<br />
*** Define the Level 2 custom fields that will be used for each defined address component.<br />
[[File:L2AddressMapping1.png|thumb|none|800px|Address Mapping]]<br />
<br />
* In order for the Level 2 record to store the latitude and longitude for the location, the Level 2 record must be saved after the address details have been entered in the address custom fields. Alternatively, you may use a workflow on the Level 2 record that uses the 'Retrieve Latitude/Longitude' workflow task type. This workflow task will automatically calculate the latitude and longitude based on the custom field address values. The workflow must be triggered at a point in time after the address values have been entered in the Level 2 record.<br />
<br />
<br />
<br />
=<br data-attributes="%20/">Additional Map Theme Styles=<br />
Blue Water[[File:Blue_Water.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Facebook<br />
[[File:Facebook.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Light Grayscale<br />
[[File:Light_Grayscale.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Golden Brown<br />
[[File:Golden_Brown.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Retro<br />
[[File:Retro.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
==See Also==<br />
* [[KML]]<br />
<br />
[[Category:Tools]]<br />
[[Category:Geocoding]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Impact_Map&diff=37161Impact Map2019-10-09T15:43:35Z<p>DEardley: </p>
<hr />
<div>=Overview=<br />
The Impact Map is a feature that can be used to plot records from a UTA on a map interface to display locations from the UTA records.<br />
<br />
This feature provides a unique method for visualizing your data using geomapping functionality, commonly used for displaying locations of grant impact.<br />
<br />
In order to configure an Impact Map, you will need administrator access to the UTA that will be used for generating the locations on the map.<br />
<br />
=Configuration - Essentials=<br />
* Choose the UTA the map will be associated with based on the types of records you want to present on the map.<br />
* An Impact Map can be created using either Level 1 or Level 2 records in the UTA. <br />
** Level 1 records will be displayed on the Impact Map using the location of the organization (standard field: client) associated to the record.<br />
** Level 2 records may be displayed on the Impact Map using a unique address that will be defined using Geocode Field Mapping settings. See 'Configuration - Advanced' for additional steps that are required.<br />
* In order for records to be plotted on the map, the use of the standard fields 'Latitude' and 'Longitude' must be enabled on your records. Review your records' standard fields, and enable these fields if not completed previously.<br />
** Note: The values for Latitude and Longitude must be stored to the record by either saving the record or using the 'Retrieve Latitude/Longitude' workflow task type.<br />
* In the UTA Configuration Settings, navigate to the Level 2 tab and select the 'Impact Map Settings' link. <br />
** Create a new map using the (+) Create New Map button in the menu. Assign the map settings based on the available parameters listed in the 'Settings Explained' section below.<br />
** Once you have entered all of the settings for the map, save the map. <br />
** Click the 'Generate HTML and JSON files' button to create the required files that will be stored to your selected SmartFolder. The HTML file URL will be accessible in the Impact Map configuration page. This can be referenced for navigating to the map, and can be utilized in portal design by referencing the relative URL in a custom page or custom portal section (Example: /files/368847/f304276/11_impactmap.html).<br />
<br />
==Settings Explained==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Name<br />
||The name of the map you are creating.<br />
|-<br />
||Description<br />
||Used for storing additional detail about the map.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Status Filter<br />
||Filters the records being plotted on the map based on the record status.<br />
|-<br />
||Amount Field<br />
||The field that will be used in an aggregate sum displayed on the map (Grant Total: $###).<br />
|-<br />
||Zoom Level<br />
||The level of zoom defined for loading the page on the Zoom Center you select.<br />
|-<br />
||Zoom Center<br />
||The location on the map that the map will default in loading.<br />
|-<br />
||Auto Zoom<br />
||This option will automatically load the map zoomed in on the area where records exist. If selected, the Zoom Level and Zoom Center are not utilized.<br />
|-<br />
||Map Theme<br />
||The style of the map that will be displayed.<br />
|-<br />
||Marker URL<br />
||This can be utilized to reference an image file for use as the map markers in place of the default Google Maps marker. This is not required if you want to use the default marker.<br />
|-<br />
||Information Fields<br />
||Select the fields from the UTA record that you want displayed in the information box that will be displayed when selecting a marker on the map.<br />
|-<br />
||Information Template<br />
||This can be utilized if you plan to use a custom template for the Information Fields display on the map. This is not required.<br />
|-<br />
||[[KML]]<br />
||You can add references to KML files for your map so that KML overlays can be applied to the map. This is not required.<br />
|-<br />
||SmartFolder<br />
||You must select a SmartFolder where the map files will be stored to within your SmartSimple instance.<br />
|}<br />
<br />
=Configuration - Advanced=<br />
By creating a Level 2 Impact Map, you have the flexibility to present a unique address for your location, but also have the ability to present multiple locations for a single Level 1. For example, if you have a Level 1 Grant that occurs in multiple locations, you can create multiple location Level 2 activities to plot multiple points on the Impact Map.<br />
<br />
One approach for creating your Level 2 location activities is the use of an Advanced Data Table custom field on your Level 1 record which is mapped to create Level 2 records. With this approach, you can enter multiple locations in the Advanced Data Table field, and each will create a Level 2 record automatically. See [[Custom_Field_Type:_Special_-_Advanced_Data_Table]] for steps on Managing Level 2 / 3 Activities with a Section.<br />
<br />
When creating an Impact Map using Level 2 records, you will need to take several additional configuration steps that are not required for Level 1 record maps.<br />
<br />
* Ensure that the 'Latitude' and 'Longitude' standard fields are enabled on your Level 2 object in your UTA. Navigate to your Standard Fields list for your Level 2 object and save the 'Latitude' and 'Longitude' fields if they have not been enabled previously.<br />
* Create custom fields on your Level 2 object for storing the address that will be plotted on the Impact Map. These may include fields to capture Address 1, Address 2, City, State Country, Postal Code. You must separate each attribute into a distinct field.<br />
* Geocode Field Mapping must be established on your Level 2 object. The Geocode Field Mapping feature allows for the calculation of latitude and longitude based on addresses entered against level 2 custom fields.<br />
** Navigate to your UTA configuration settings, view the Level 2 object tab, and click on the the link labeled ''Geocode Field Mapping''.<br />
*** Define the Level 2 custom fields that will be used for each defined address component.<br />
[[File:L2AddressMapping1.png|thumb|none|800px|Address Mapping]]<br />
<br />
* In order for the Level 2 record to store the latitude and longitude for the location, the Level 2 record must be saved after the address details have been entered in the address custom fields. Alternatively, you may use a workflow on the Level 2 record that uses the 'Retrieve Latitude/Longitude' workflow task type. This workflow task will automatically calculate the latitude and longitude based on the custom field address values. The workflow must be triggered at a point in time after the address values have been entered in the Level 2 record.<br />
<br />
<br />
=<br data-attributes="%20/">Impact Map Example=<br />
Theme: Default<br />
<br />
[[File:Map_Sample.png|thumb|none|1000px|Sample Impact Map Display.]]<br />
<br />
=<br data-attributes="%20/">Additional Map Theme Styles=<br />
Blue Water[[File:Blue_Water.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Facebook<br />
[[File:Facebook.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Light Grayscale<br />
[[File:Light_Grayscale.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Golden Brown<br />
[[File:Golden_Brown.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Retro<br />
[[File:Retro.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
==See Also==<br />
* [[KML]]<br />
<br />
[[Category:Tools]]<br />
[[Category:Geocoding]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Impact_Map&diff=37160Impact Map2019-10-09T15:41:13Z<p>DEardley: /* Settings Explained */</p>
<hr />
<div>=Overview=<br />
The Impact Map is a feature that can be used to plot records from a UTA on a map interface to display locations from the UTA records.<br />
<br />
This feature provides a unique method for visualizing your data using geomapping functionality, commonly used for displaying locations of grant impact.<br />
<br />
In order to configure an Impact Map, you will need administrator access to the UTA that will be used for generating the locations on the map.<br />
<br />
=Configuration - Essentials=<br />
* Choose the UTA the map will be associated with based on the types of records you want to present on the map.<br />
* An Impact Map can be created using either Level 1 or Level 2 records in the UTA. <br />
** Level 1 records will be displayed on the Impact Map using the location of the organization (standard field: client) associated to the record.<br />
** Level 2 records may be displayed on the Impact Map using a unique address that will be defined using Geocode Field Mapping settings. See 'Configuration - Advanced' for additional steps that are required.<br />
* In order for records to be plotted on the map, the use of the standard fields 'Latitude' and 'Longitude' must be enabled on your records. Review your records' standard fields, and enable these fields if not completed previously.<br />
** Note: The values for Latitude and Longitude must be stored to the record by either saving the record or using the 'Retrieve Latitude/Longitude' workflow task type.<br />
* In the UTA Configuration Settings, navigate to the Level 2 tab and select the 'Impact Map Settings' link. <br />
** Create a new map using the (+) Create New Map button in the menu. Assign the map settings based on the available parameters listed in the 'Settings Explained' section below.<br />
** Once you have entered all of the settings for the map, save the map. <br />
** Click the 'Generate HTML and JSON files' button to create the required files that will be stored to your selected SmartFolder. The HTML file URL will be accessible in the Impact Map configuration page. This can be referenced for navigating to the map, and can be utilized in portal design by referencing the relative URL in a custom page or custom portal section (Example: /files/368847/f304276/11_impactmap.html).<br />
<br />
=Configuration - Advanced=<br />
By creating a Level 2 Impact Map, you have the flexibility to present a unique address for your location, but also have the ability to present multiple locations for a single Level 1. For example, if you have a Level 1 Grant that occurs in multiple locations, you can create multiple location Level 2 activities to plot multiple points on the Impact Map.<br />
<br />
One approach for creating your Level 2 location activities is the use of an Advanced Data Table custom field on your Level 1 record which is mapped to create Level 2 records. With this approach, you can enter multiple locations in the Advanced Data Table field, and each will create a Level 2 record automatically. See [[Custom_Field_Type:_Special_-_Advanced_Data_Table]] for steps on Managing Level 2 / 3 Activities with a Section.<br />
<br />
When creating an Impact Map using Level 2 records, you will need to take several additional configuration steps that are not required for Level 1 record maps.<br />
<br />
* Ensure that the 'Latitude' and 'Longitude' standard fields are enabled on your Level 2 object in your UTA. Navigate to your Standard Fields list for your Level 2 object and save the 'Latitude' and 'Longitude' fields if they have not been enabled previously.<br />
* Create custom fields on your Level 2 object for storing the address that will be plotted on the Impact Map. These may include fields to capture Address 1, Address 2, City, State Country, Postal Code. You must separate each attribute into a distinct field.<br />
* Geocode Field Mapping must be established on your Level 2 object. The Geocode Field Mapping feature allows for the calculation of latitude and longitude based on addresses entered against level 2 custom fields.<br />
** Navigate to your UTA configuration settings, view the Level 2 object tab, and click on the the link labeled ''Geocode Field Mapping''.<br />
*** Define the Level 2 custom fields that will be used for each defined address component.<br />
[[File:L2AddressMapping1.png|thumb|none|800px|Address Mapping]]<br />
<br />
* In order for the Level 2 record to store the latitude and longitude for the location, the Level 2 record must be saved after the address details have been entered in the address custom fields. Alternatively, you may use a workflow on the Level 2 record that uses the 'Retrieve Latitude/Longitude' workflow task type. This workflow task will automatically calculate the latitude and longitude based on the custom field address values. The workflow must be triggered at a point in time after the address values have been entered in the Level 2 record.<br />
<br />
<br />
<br />
<br />
==Settings Explained==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Name<br />
||The name of the map you are creating.<br />
|-<br />
||Description<br />
||Used for storing additional detail about the map.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Status Filter<br />
||Filters the records being plotted on the map based on the record status.<br />
|-<br />
||Amount Field<br />
||The field that will be used in an aggregate sum displayed on the map (Grant Total: $###).<br />
|-<br />
||Zoom Level<br />
||The level of zoom defined for loading the page on the Zoom Center you select.<br />
|-<br />
||Zoom Center<br />
||The location on the map that the map will default in loading.<br />
|-<br />
||Auto Zoom<br />
||This option will automatically load the map zoomed in on the area where records exist. If selected, the Zoom Level and Zoom Center are not utilized.<br />
|-<br />
||Map Theme<br />
||The style of the map that will be displayed.<br />
|-<br />
||Marker URL<br />
||This can be utilized to reference an image file for use as the map markers in place of the default Google Maps marker. This is not required if you want to use the default marker.<br />
|-<br />
||Information Fields<br />
||Select the fields from the UTA record that you want displayed in the information box that will be displayed when selecting a marker on the map.<br />
|-<br />
||Information Template<br />
||This can be utilized if you plan to use a custom template for the Information Fields display on the map. This is not required.<br />
|-<br />
||[[KML]]<br />
||You can add references to KML files for your map so that KML overlays can be applied to the map. This is not required.<br />
|-<br />
||SmartFolder<br />
||You must select a SmartFolder where the map files will be stored to within your SmartSimple instance.<br />
|}<br />
<br />
=<br data-attributes="%20/">Impact Map Example=<br />
Theme: Default<br />
<br />
[[File:Map_Sample.png|thumb|none|1000px|Sample Impact Map Display.]]<br />
<br />
=<br data-attributes="%20/">Additional Map Theme Styles=<br />
Blue Water[[File:Blue_Water.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Facebook<br />
[[File:Facebook.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Light Grayscale<br />
[[File:Light_Grayscale.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Golden Brown<br />
[[File:Golden_Brown.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Retro<br />
[[File:Retro.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
==See Also==<br />
* [[KML]]<br />
<br />
[[Category:Tools]]<br />
[[Category:Geocoding]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Impact_Map&diff=37159Impact Map2019-10-09T15:40:17Z<p>DEardley: </p>
<hr />
<div>=Overview=<br />
The Impact Map is a feature that can be used to plot records from a UTA on a map interface to display locations from the UTA records.<br />
<br />
This feature provides a unique method for visualizing your data using geomapping functionality, commonly used for displaying locations of grant impact.<br />
<br />
In order to configure an Impact Map, you will need administrator access to the UTA that will be used for generating the locations on the map.<br />
<br />
=Configuration - Essentials=<br />
* Choose the UTA the map will be associated with based on the types of records you want to present on the map.<br />
* An Impact Map can be created using either Level 1 or Level 2 records in the UTA. <br />
** Level 1 records will be displayed on the Impact Map using the location of the organization (standard field: client) associated to the record.<br />
** Level 2 records may be displayed on the Impact Map using a unique address that will be defined using Geocode Field Mapping settings. See 'Configuration - Advanced' for additional steps that are required.<br />
* In order for records to be plotted on the map, the use of the standard fields 'Latitude' and 'Longitude' must be enabled on your records. Review your records' standard fields, and enable these fields if not completed previously.<br />
** Note: The values for Latitude and Longitude must be stored to the record by either saving the record or using the 'Retrieve Latitude/Longitude' workflow task type.<br />
* In the UTA Configuration Settings, navigate to the Level 2 tab and select the 'Impact Map Settings' link. <br />
** Create a new map using the (+) Create New Map button in the menu. Assign the map settings based on the available parameters listed in the 'Settings Explained' section below.<br />
** Once you have entered all of the settings for the map, save the map. <br />
** Click the 'Generate HTML and JSON files' button to create the required files that will be stored to your selected SmartFolder. The HTML file URL will be accessible in the Impact Map configuration page. This can be referenced for navigating to the map, and can be utilized in portal design by referencing the relative URL in a custom page or custom portal section (Example: /files/368847/f304276/11_impactmap.html).<br />
<br />
=Configuration - Advanced=<br />
By creating a Level 2 Impact Map, you have the flexibility to present a unique address for your location, but also have the ability to present multiple locations for a single Level 1. For example, if you have a Level 1 Grant that occurs in multiple locations, you can create multiple location Level 2 activities to plot multiple points on the Impact Map.<br />
<br />
One approach for creating your Level 2 location activities is the use of an Advanced Data Table custom field on your Level 1 record which is mapped to create Level 2 records. With this approach, you can enter multiple locations in the Advanced Data Table field, and each will create a Level 2 record automatically. See [[Custom_Field_Type:_Special_-_Advanced_Data_Table]] for steps on Managing Level 2 / 3 Activities with a Section.<br />
<br />
When creating an Impact Map using Level 2 records, you will need to take several additional configuration steps that are not required for Level 1 record maps.<br />
<br />
* Ensure that the 'Latitude' and 'Longitude' standard fields are enabled on your Level 2 object in your UTA. Navigate to your Standard Fields list for your Level 2 object and save the 'Latitude' and 'Longitude' fields if they have not been enabled previously.<br />
* Create custom fields on your Level 2 object for storing the address that will be plotted on the Impact Map. These may include fields to capture Address 1, Address 2, City, State Country, Postal Code. You must separate each attribute into a distinct field.<br />
* Geocode Field Mapping must be established on your Level 2 object. The Geocode Field Mapping feature allows for the calculation of latitude and longitude based on addresses entered against level 2 custom fields.<br />
** Navigate to your UTA configuration settings, view the Level 2 object tab, and click on the the link labeled ''Geocode Field Mapping''.<br />
*** Define the Level 2 custom fields that will be used for each defined address component.<br />
[[File:L2AddressMapping1.png|thumb|none|800px|Address Mapping]]<br />
<br />
* In order for the Level 2 record to store the latitude and longitude for the location, the Level 2 record must be saved after the address details have been entered in the address custom fields. Alternatively, you may use a workflow on the Level 2 record that uses the 'Retrieve Latitude/Longitude' workflow task type. This workflow task will automatically calculate the latitude and longitude based on the custom field address values. The workflow must be triggered at a point in time after the address values have been entered in the Level 2 record.<br />
<br />
<br />
<br />
<br />
==Settings Explained==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Name<br />
||The name of the map you are creating.<br />
|-<br />
||Description<br />
||Used for storing additional detail about the map.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Status Filter<br />
||Filters the records being plotted on the map based on the record status.<br />
|-<br />
||Amount Field<br />
||The field that will be used in an aggregate sum displayed on the map (Grant Total: $###).<br />
|-<br />
||Zoom Level<br />
||The level of zoom defined for loading the page on the Zoom Center you select.<br />
|-<br />
||Zoom Center<br />
||The location on the map that the map will default in loading.<br />
|-<br />
||Auto Zoom<br />
||This option will automatically load the map zoomed in on the area where records exist. If selected, the Zoom Level and Zoom Center are not utilized.<br />
|-<br />
||Map Theme<br />
||The style of the map that will be displayed.<br />
|-<br />
||Marker URL<br />
||This can be utilized to reference an image file for use as the map markers in place of the default Google Maps marker. This is not required if you want to use the default marker.<br />
|-<br />
||Information Fields<br />
||Select the fields from the UTA record that you want displayed in the information box that will be displayed when selecting a marker on the map.<br />
|-<br />
||Information Template<br />
||This can be utilized if you plan to use a custom template for the Information Fields display on the map. This is not required.<br />
|-<br />
||KML<br />
||You can add references to KML files for your map so that KML overlays can be applied to the map. This is not required.<br />
|-<br />
||SmartFolder<br />
||You must select a SmartFolder where the map files will be stored to within your SmartSimple instance.<br />
|}<br />
<br />
=<br data-attributes="%20/">Impact Map Example=<br />
Theme: Default<br />
<br />
[[File:Map_Sample.png|thumb|none|1000px|Sample Impact Map Display.]]<br />
<br />
=<br data-attributes="%20/">Additional Map Theme Styles=<br />
Blue Water[[File:Blue_Water.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Facebook<br />
[[File:Facebook.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Light Grayscale<br />
[[File:Light_Grayscale.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Golden Brown<br />
[[File:Golden_Brown.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Retro<br />
[[File:Retro.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
==See Also==<br />
* [[KML]]<br />
<br />
[[Category:Tools]]<br />
[[Category:Geocoding]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Impact_Map&diff=37158Impact Map2019-10-09T15:38:32Z<p>DEardley: </p>
<hr />
<div>=Overview=<br />
The Impact Map is a feature that can be used to plot records from a UTA on a map interface to display locations from the UTA records.<br />
<br />
This feature provides a unique method for visualizing your data using geomapping functionality, commonly used for displaying locations of grant impact.<br />
<br />
In order to configure an Impact Map, you will need administrator access to the UTA that will be used for generating the locations on the map.<br />
<br />
=Configuration - Essentials=<br />
* Choose the UTA the map will be associated with based on the types of records you want to present on the map.<br />
* An Impact Map can be created using either Level 1 or Level 2 records in the UTA. <br />
** Level 1 records will be displayed on the Impact Map using the location of the organization (standard field: client) associated to the record.<br />
** Level 2 records may be displayed on the Impact Map using a unique address that will be defined using Geocode Field Mapping settings. See 'Configuration - Advanced' for additional steps that are required.<br />
* In order for records to be plotted on the map, the use of the standard fields 'Latitude' and 'Longitude' must be enabled on your records. Review your records' standard fields, and enable these fields if not completed previously.<br />
** Note: The values for Latitude and Longitude must be stored to the record by either saving the record or using the 'Retrieve Latitude/Longitude' workflow task type.<br />
* In the UTA Configuration Settings, navigate to the Level 2 tab and select the 'Impact Map Settings' link. <br />
** Create a new map using the (+) Create New Map button in the menu. Assign the map settings based on the available parameters listed in the 'Settings Explained' section below.<br />
** Once you have entered all of the settings for the map, save the map. <br />
** Click the 'Generate HTML and JSON files' button to create the required files that will be stored to your selected SmartFolder. The HTML file URL will be accessible in the Impact Map configuration page. This can be referenced for navigating to the map, and can be utilized in portal design by referencing the relative URL in a custom page or custom portal section (Example: /files/368847/f304276/11_impactmap.html).<br />
<br />
=Configuration - Advanced=<br />
If you are creating an Impact Map using Level 2 records, you will need to take several additional steps that are not required for Level 1 record maps.<br />
<br />
* Ensure that the 'Latitude' and 'Longitude' standard fields are enabled on your Level 2 object in your UTA. Navigate to your Standard Fields list for your Level 2 object and save the 'Latitude' and 'Longitude' fields if they have not been enabled previously.<br />
* Create custom fields on your Level 2 object for storing the address that will be plotted on the Impact Map. These may include fields to capture Address 1, Address 2, City, State Country, Postal Code. You must separate each attribute into a distinct field.<br />
* Geocode Field Mapping must be established on your Level 2 object. The Geocode Field Mapping feature allows for the calculation of latitude and longitude based on addresses entered against level 2 custom fields.<br />
** Navigate to your UTA configuration settings, view the Level 2 object tab, and click on the the link labeled ''Geocode Field Mapping''.<br />
*** Define the Level 2 custom fields that will be used for each defined address component.<br />
[[File:L2AddressMapping1.png|thumb|none|800px|Address Mapping]]<br />
<br />
* In order for the Level 2 record to store the latitude and longitude for the location, the Level 2 record must be saved after the address details have been entered in the address custom fields. Alternatively, you may use a workflow on the Level 2 record that uses the 'Retrieve Latitude/Longitude' workflow task type. This workflow task will automatically calculate the latitude and longitude based on the custom field address values. The workflow must be triggered at a point in time after the address values have been entered in the Level 2 record.<br />
<br />
<br />
By using a Level 2 Impact Map, you have the flexibility to present a unique address for your location, but also have the ability to present multiple locations for a single Level 1. For example, if you have a Level 1 Grant that occurs in multiple locations, you can create multiple location Level 2 activities to plot multiple points on the Impact Map.<br />
<br />
One approach for creating your Level 2 location activities is the use of an Advanced Data Table custom field on your Level 1 record which is mapped to create Level 2 records. With this approach, you can enter multiple locations in the Advanced Data Table field, and each will create a Level 2 record automatically. See [[Custom_Field_Type:_Special_-_Advanced_Data_Table]] for steps on Managing Level 2 / 3 Activities with a Section.<br />
<br />
<br />
<br />
==Settings Explained==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Name<br />
||The name of the map you are creating.<br />
|-<br />
||Description<br />
||Used for storing additional detail about the map.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Status Filter<br />
||Filters the records being plotted on the map based on the record status.<br />
|-<br />
||Amount Field<br />
||The field that will be used in an aggregate sum displayed on the map (Grant Total: $###).<br />
|-<br />
||Zoom Level<br />
||The level of zoom defined for loading the page on the Zoom Center you select.<br />
|-<br />
||Zoom Center<br />
||The location on the map that the map will default in loading.<br />
|-<br />
||Auto Zoom<br />
||This option will automatically load the map zoomed in on the area where records exist. If selected, the Zoom Level and Zoom Center are not utilized.<br />
|-<br />
||Map Theme<br />
||The style of the map that will be displayed.<br />
|-<br />
||Marker URL<br />
||This can be utilized to reference an image file for use as the map markers in place of the default Google Maps marker. This is not required if you want to use the default marker.<br />
|-<br />
||Information Fields<br />
||Select the fields from the UTA record that you want displayed in the information box that will be displayed when selecting a marker on the map.<br />
|-<br />
||Information Template<br />
||This can be utilized if you plan to use a custom template for the Information Fields display on the map. This is not required.<br />
|-<br />
||KML<br />
||You can add references to KML files for your map so that KML overlays can be applied to the map. This is not required.<br />
|-<br />
||SmartFolder<br />
||You must select a SmartFolder where the map files will be stored to within your SmartSimple instance.<br />
|}<br />
<br />
=<br data-attributes="%20/">Impact Map Example=<br />
Theme: Default<br />
<br />
[[File:Map_Sample.png|thumb|none|1000px|Sample Impact Map Display.]]<br />
<br />
=<br data-attributes="%20/">Additional Map Theme Styles=<br />
Blue Water[[File:Blue_Water.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Facebook<br />
[[File:Facebook.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Light Grayscale<br />
[[File:Light_Grayscale.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Golden Brown<br />
[[File:Golden_Brown.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Retro<br />
[[File:Retro.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
==See Also==<br />
* [[KML]]<br />
<br />
[[Category:Tools]]<br />
[[Category:Geocoding]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Impact_Map&diff=37157Impact Map2019-10-09T15:30:57Z<p>DEardley: /* Configuration - Essentials */</p>
<hr />
<div>=Overview=<br />
The Impact Map is a feature that can be used to plot records from a UTA on a map interface to display locations from the UTA records.<br />
<br />
This feature provides a unique method for visualizing your data using geomapping functionality, commonly used for displaying locations of grant impact.<br />
<br />
In order to configure an Impact Map, you will need administrator access to the UTA that will be used for generating the locations on the map.<br />
<br />
=Configuration - Essentials=<br />
* Choose the UTA the map will be associated with based on the types of records you want to present on the map.<br />
* An Impact Map can be created using either Level 1 or Level 2 records in the UTA. <br />
** Level 1 records will be displayed on the Impact Map using the location of the organization (standard field: client) associated to the record.<br />
** Level 2 records may be displayed on the Impact Map using a unique address that will be defined using Geocode Field Mapping settings. See 'Configuration - Advanced' for additional steps that are required.<br />
* In order for records to be plotted on the map, the use of the standard fields 'Latitude' and 'Longitude' must be enabled on your records. Review your records' standard fields, and enable these fields if not completed previously.<br />
** Note: The values for Latitude and Longitude must be stored to the record by either saving the record or using the 'Retrieve Latitude/Longitude' workflow task type.<br />
* In the UTA Settings, go to the Level 2 tab and select the 'Impact Map Settings' link. <br />
** Create a new map using the (+) button in the menu. Enter the map settings details based on the available parameters.<br />
** Once you have entered all of the settings for the map, save the map. <br />
** Click the 'Generate HTML and JSON files' button to create the required files that will be stored to your selected SmartFolder. The HTML file URL will be accessible in the Impact Map configuration page. This can be referenced for navigating to the map, and can be utilized in portal design by referencing the relative URL in a custom page or custom portal section (Example: /files/368847/f304276/11_impactmap.html).<br />
<br />
=Configuration - Advanced=<br />
If you are creating an Impact Map using Level 2 records, you will need to take several additional steps that are not required for Level 1 record maps.<br />
<br />
* Ensure that the 'Latitude' and 'Longitude' standard fields are enabled on your Level 2 object in your UTA. Navigate to your Standard Fields list for your Level 2 object and save the 'Latitude' and 'Longitude' fields if they have not been enabled previously.<br />
* Create custom fields on your Level 2 object for storing the address that will be plotted on the Impact Map. These may include fields to capture Address 1, Address 2, City, State Country, Postal Code. You must separate each attribute into a distinct field.<br />
* Geocode Field Mapping must be established on your Level 2 object. The Geocode Field Mapping feature allows for the calculation of latitude and longitude based on addresses entered against level 2 custom fields.<br />
** Navigate to your UTA configuration settings, view the Level 2 object tab, and click on the the link labeled ''Geocode Field Mapping''.<br />
*** Define the Level 2 custom fields that will be used for each defined address component.<br />
[[File:L2AddressMapping1.png|thumb|none|800px|Address Mapping]]<br />
<br />
* In order for the Level 2 record to store the latitude and longitude for the location, the Level 2 record must be saved after the address details have been entered in the address custom fields. Alternatively, you may use a workflow on the Level 2 record that uses the 'Retrieve Latitude/Longitude' workflow task type. This workflow task will automatically calculate the latitude and longitude based on the custom field address values. The workflow must be triggered at a point in time after the address values have been entered in the Level 2 record.<br />
<br />
<br />
<br />
<br />
<br />
==Settings Explained==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Name<br />
||The name of the map you are creating.<br />
|-<br />
||Description<br />
||Used for storing additional detail about the map.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Status Filter<br />
||Filters the records being plotted on the map based on the record status.<br />
|-<br />
||Amount Field<br />
||The field that will be used in an aggregate sum displayed on the map (Grant Total: $###).<br />
|-<br />
||Zoom Level<br />
||The level of zoom defined for loading the page on the Zoom Center you select.<br />
|-<br />
||Zoom Center<br />
||The location on the map that the map will default in loading.<br />
|-<br />
||Auto Zoom<br />
||This option will automatically load the map zoomed in on the area where records exist. If selected, the Zoom Level and Zoom Center are not utilized.<br />
|-<br />
||Map Theme<br />
||The style of the map that will be displayed.<br />
|-<br />
||Marker URL<br />
||This can be utilized to reference an image file for use as the map markers in place of the default Google Maps marker. This is not required if you want to use the default marker.<br />
|-<br />
||Information Fields<br />
||Select the fields from the UTA record that you want displayed in the information box that will be displayed when selecting a marker on the map.<br />
|-<br />
||Information Template<br />
||This can be utilized if you plan to use a custom template for the Information Fields display on the map. This is not required.<br />
|-<br />
||KML<br />
||You can add references to KML files for your map so that KML overlays can be applied to the map. This is not required.<br />
|-<br />
||SmartFolder<br />
||You must select a SmartFolder where the map files will be stored to within your SmartSimple instance.<br />
|}<br />
<br />
=<br data-attributes="%20/">Impact Map Example=<br />
Theme: Default<br />
<br />
[[File:Map_Sample.png|thumb|none|1000px|Sample Impact Map Display.]]<br />
<br />
=<br data-attributes="%20/">Additional Map Theme Styles=<br />
Blue Water[[File:Blue_Water.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Facebook<br />
[[File:Facebook.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Light Grayscale<br />
[[File:Light_Grayscale.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Golden Brown<br />
[[File:Golden_Brown.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Retro<br />
[[File:Retro.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
==See Also==<br />
* [[KML]]<br />
<br />
[[Category:Tools]]<br />
[[Category:Geocoding]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Impact_Map&diff=37156Impact Map2019-10-09T15:21:49Z<p>DEardley: /* See Also */</p>
<hr />
<div>=Overview=<br />
The Impact Map is a feature that can be used to plot records from a UTA on a map interface to display locations from the UTA records.<br />
<br />
This feature provides a unique method for visualizing your data using geomapping functionality, commonly used for displaying locations of grant impact.<br />
<br />
In order to configure an Impact Map, you will need administrator access to the UTA that will be used for generating the locations on the map.<br />
<br />
=Configuration - Essentials=<br />
* Choose the UTA the map will be associated with based on the types of records you want to present on the map.<br />
* An Impact Map can be created using either Level 1 or Level 2 records in the UTA. <br />
** Level 1 records will be displayed on the Impact Map using the location of the organization (client) associated to the record.<br />
** Level 2 records may be displayed on the Impact Map using a unique address that will be defined using Geocode Field Mapping settings. See 'Configuration - Advanced' for additional steps that are required.<br />
* In order for records to be plotted on the map, the use of the standard fields 'Latitude' and 'Longitude' must be enabled on your records. Review your records' standard fields, and enable these fields if not completed previously.<br />
** Note: The values for Latitude and Longitude must be stored to the record by either saving the record or using the 'Retrieve Latitude/Longitude' workflow task type.<br />
* In the UTA Settings, go to the Level 2 tab and select the 'Impact Map Settings' link. <br />
** Create a new map using the (+) button in the menu. Enter the map settings details based on the available parameters.<br />
** Once you have entered all of the settings for the map, save the map. <br />
** Click the 'Generate HTML and JSON files' button to create the required files that will be stored to your selected SmartFolder. The HTML file URL will be accessible in the Impact Map configuration page. This can be referenced for navigating to the map, and can be utilized in portal design by referencing the relative URL in a custom page or custom portal section (Example: /files/368847/f304276/11_impactmap.html).<br />
<br />
=Configuration - Advanced=<br />
If you are creating an Impact Map using Level 2 records, you will need to take several additional steps that are not required for Level 1 record maps.<br />
<br />
* Ensure that the 'Latitude' and 'Longitude' standard fields are enabled on your Level 2 object in your UTA. Navigate to your Standard Fields list for your Level 2 object and save the 'Latitude' and 'Longitude' fields if they have not been enabled previously.<br />
* Create custom fields on your Level 2 object for storing the address that will be plotted on the Impact Map. These may include fields to capture Address 1, Address 2, City, State Country, Postal Code. You must separate each attribute into a distinct field.<br />
* Geocode Field Mapping must be established on your Level 2 object. The Geocode Field Mapping feature allows for the calculation of latitude and longitude based on addresses entered against level 2 custom fields.<br />
** Navigate to your UTA configuration settings, view the Level 2 object tab, and click on the the link labeled ''Geocode Field Mapping''.<br />
*** Define the Level 2 custom fields that will be used for each defined address component.<br />
[[File:L2AddressMapping1.png|thumb|none|800px|Address Mapping]]<br />
<br />
* In order for the Level 2 record to store the latitude and longitude for the location, the Level 2 record must be saved after the address details have been entered in the address custom fields. Alternatively, you may use a workflow on the Level 2 record that uses the 'Retrieve Latitude/Longitude' workflow task type. This workflow task will automatically calculate the latitude and longitude based on the custom field address values. The workflow must be triggered at a point in time after the address values have been entered in the Level 2 record.<br />
<br />
<br />
<br />
<br />
<br />
==Settings Explained==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Name<br />
||The name of the map you are creating.<br />
|-<br />
||Description<br />
||Used for storing additional detail about the map.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Status Filter<br />
||Filters the records being plotted on the map based on the record status.<br />
|-<br />
||Amount Field<br />
||The field that will be used in an aggregate sum displayed on the map (Grant Total: $###).<br />
|-<br />
||Zoom Level<br />
||The level of zoom defined for loading the page on the Zoom Center you select.<br />
|-<br />
||Zoom Center<br />
||The location on the map that the map will default in loading.<br />
|-<br />
||Auto Zoom<br />
||This option will automatically load the map zoomed in on the area where records exist. If selected, the Zoom Level and Zoom Center are not utilized.<br />
|-<br />
||Map Theme<br />
||The style of the map that will be displayed.<br />
|-<br />
||Marker URL<br />
||This can be utilized to reference an image file for use as the map markers in place of the default Google Maps marker. This is not required if you want to use the default marker.<br />
|-<br />
||Information Fields<br />
||Select the fields from the UTA record that you want displayed in the information box that will be displayed when selecting a marker on the map.<br />
|-<br />
||Information Template<br />
||This can be utilized if you plan to use a custom template for the Information Fields display on the map. This is not required.<br />
|-<br />
||KML<br />
||You can add references to KML files for your map so that KML overlays can be applied to the map. This is not required.<br />
|-<br />
||SmartFolder<br />
||You must select a SmartFolder where the map files will be stored to within your SmartSimple instance.<br />
|}<br />
<br />
=<br data-attributes="%20/">Impact Map Example=<br />
Theme: Default<br />
<br />
[[File:Map_Sample.png|thumb|none|1000px|Sample Impact Map Display.]]<br />
<br />
=<br data-attributes="%20/">Additional Map Theme Styles=<br />
Blue Water[[File:Blue_Water.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Facebook<br />
[[File:Facebook.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Light Grayscale<br />
[[File:Light_Grayscale.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Golden Brown<br />
[[File:Golden_Brown.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Retro<br />
[[File:Retro.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
==See Also==<br />
* [[KML]]<br />
<br />
[[Category:Tools]]<br />
[[Category:Geocoding]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Impact_Map&diff=37155Impact Map2019-10-09T15:21:17Z<p>DEardley: </p>
<hr />
<div>=Overview=<br />
The Impact Map is a feature that can be used to plot records from a UTA on a map interface to display locations from the UTA records.<br />
<br />
This feature provides a unique method for visualizing your data using geomapping functionality, commonly used for displaying locations of grant impact.<br />
<br />
In order to configure an Impact Map, you will need administrator access to the UTA that will be used for generating the locations on the map.<br />
<br />
=Configuration - Essentials=<br />
* Choose the UTA the map will be associated with based on the types of records you want to present on the map.<br />
* An Impact Map can be created using either Level 1 or Level 2 records in the UTA. <br />
** Level 1 records will be displayed on the Impact Map using the location of the organization (client) associated to the record.<br />
** Level 2 records may be displayed on the Impact Map using a unique address that will be defined using Geocode Field Mapping settings. See 'Configuration - Advanced' for additional steps that are required.<br />
* In order for records to be plotted on the map, the use of the standard fields 'Latitude' and 'Longitude' must be enabled on your records. Review your records' standard fields, and enable these fields if not completed previously.<br />
** Note: The values for Latitude and Longitude must be stored to the record by either saving the record or using the 'Retrieve Latitude/Longitude' workflow task type.<br />
* In the UTA Settings, go to the Level 2 tab and select the 'Impact Map Settings' link. <br />
** Create a new map using the (+) button in the menu. Enter the map settings details based on the available parameters.<br />
** Once you have entered all of the settings for the map, save the map. <br />
** Click the 'Generate HTML and JSON files' button to create the required files that will be stored to your selected SmartFolder. The HTML file URL will be accessible in the Impact Map configuration page. This can be referenced for navigating to the map, and can be utilized in portal design by referencing the relative URL in a custom page or custom portal section (Example: /files/368847/f304276/11_impactmap.html).<br />
<br />
=Configuration - Advanced=<br />
If you are creating an Impact Map using Level 2 records, you will need to take several additional steps that are not required for Level 1 record maps.<br />
<br />
* Ensure that the 'Latitude' and 'Longitude' standard fields are enabled on your Level 2 object in your UTA. Navigate to your Standard Fields list for your Level 2 object and save the 'Latitude' and 'Longitude' fields if they have not been enabled previously.<br />
* Create custom fields on your Level 2 object for storing the address that will be plotted on the Impact Map. These may include fields to capture Address 1, Address 2, City, State Country, Postal Code. You must separate each attribute into a distinct field.<br />
* Geocode Field Mapping must be established on your Level 2 object. The Geocode Field Mapping feature allows for the calculation of latitude and longitude based on addresses entered against level 2 custom fields.<br />
** Navigate to your UTA configuration settings, view the Level 2 object tab, and click on the the link labeled ''Geocode Field Mapping''.<br />
*** Define the Level 2 custom fields that will be used for each defined address component.<br />
[[File:L2AddressMapping1.png|thumb|none|800px|Address Mapping]]<br />
<br />
* In order for the Level 2 record to store the latitude and longitude for the location, the Level 2 record must be saved after the address details have been entered in the address custom fields. Alternatively, you may use a workflow on the Level 2 record that uses the 'Retrieve Latitude/Longitude' workflow task type. This workflow task will automatically calculate the latitude and longitude based on the custom field address values. The workflow must be triggered at a point in time after the address values have been entered in the Level 2 record.<br />
<br />
<br />
<br />
<br />
<br />
==Settings Explained==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Name<br />
||The name of the map you are creating.<br />
|-<br />
||Description<br />
||Used for storing additional detail about the map.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Status Filter<br />
||Filters the records being plotted on the map based on the record status.<br />
|-<br />
||Amount Field<br />
||The field that will be used in an aggregate sum displayed on the map (Grant Total: $###).<br />
|-<br />
||Zoom Level<br />
||The level of zoom defined for loading the page on the Zoom Center you select.<br />
|-<br />
||Zoom Center<br />
||The location on the map that the map will default in loading.<br />
|-<br />
||Auto Zoom<br />
||This option will automatically load the map zoomed in on the area where records exist. If selected, the Zoom Level and Zoom Center are not utilized.<br />
|-<br />
||Map Theme<br />
||The style of the map that will be displayed.<br />
|-<br />
||Marker URL<br />
||This can be utilized to reference an image file for use as the map markers in place of the default Google Maps marker. This is not required if you want to use the default marker.<br />
|-<br />
||Information Fields<br />
||Select the fields from the UTA record that you want displayed in the information box that will be displayed when selecting a marker on the map.<br />
|-<br />
||Information Template<br />
||This can be utilized if you plan to use a custom template for the Information Fields display on the map. This is not required.<br />
|-<br />
||KML<br />
||You can add references to KML files for your map so that KML overlays can be applied to the map. This is not required.<br />
|-<br />
||SmartFolder<br />
||You must select a SmartFolder where the map files will be stored to within your SmartSimple instance.<br />
|}<br />
<br />
=<br data-attributes="%20/">Impact Map Example=<br />
Theme: Default<br />
<br />
[[File:Map_Sample.png|thumb|none|1000px|Sample Impact Map Display.]]<br />
<br />
=<br data-attributes="%20/">Additional Map Theme Styles=<br />
Blue Water[[File:Blue_Water.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Facebook<br />
[[File:Facebook.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Light Grayscale<br />
[[File:Light_Grayscale.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Golden Brown<br />
[[File:Golden_Brown.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Retro<br />
[[File:Retro.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
==See Also==<br />
* [[KML]]<br />
* [[Impact Quadrant]]<br />
<br />
[[Category:Tools]]<br />
[[Category:Geocoding]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Impact_Map&diff=37154Impact Map2019-10-09T15:20:11Z<p>DEardley: </p>
<hr />
<div>=Overview=<br />
The Impact Map is a feature that can be used to plot records from a UTA on a map interface to display locations from the UTA records.<br />
<br />
This feature provides a unique method for visualizing your data using geomapping functionality, commonly used for displaying locations of grant impact.<br />
<br />
In order to configure an Impact Map, you will need administrator access to the UTA that will be used for generating the locations on the map.<br />
<br />
=Configuration - Essentials=<br />
* Choose the UTA the map will be associated with based on the types of records you want to present on the map.<br />
* An Impact Map can be created using either Level 1 or Level 2 records in the UTA. <br />
** Level 1 records will be displayed on the Impact Map using the location of the organization (client) associated to the record.<br />
** Level 2 records may be displayed on the Impact Map using a unique address that will be defined using Geocode Field Mapping settings. See 'Configuration - Advanced' for additional steps that are required.<br />
* In order for records to be plotted on the map, the use of the standard fields 'Latitude' and 'Longitude' must be enabled on your records. Review your records' standard fields, and enable these fields if not completed previously.<br />
** Note: The values for Latitude and Longitude must be stored to the record by either saving the record or using the 'Retrieve Latitude/Longitude' workflow task type.<br />
* In the UTA Settings, go to the Level 2 tab and select the 'Impact Map Settings' link. <br />
** Create a new map using the (+) button in the menu. Enter the map settings details based on the available parameters.<br />
** Once you have entered all of the settings for the map, save the map. <br />
** Click the 'Generate HTML and JSON files' button to create the required files that will be stored to your selected SmartFolder. The HTML file URL will be accessible in the Impact Map configuration page. This can be referenced for navigating to the map, and can be utilized in portal design by referencing the relative URL in a custom page or custom portal section (Example: /files/368847/f304276/11_impactmap.html).<br />
<br />
=Configuration - Advanced=<br />
If you are creating an Impact Map using Level 2 records, you will need to take several additional steps that are not required for Level 1 record maps.<br />
<br />
* Ensure that the 'Latitude' and 'Longitude' standard fields are enabled on your Level 2 object in your UTA. Navigate to your Standard Fields list for your Level 2 object and save the 'Latitude' and 'Longitude' fields if they have not been enabled previously.<br />
* Create custom fields on your Level 2 object for storing the address that will be plotted on the Impact Map. These may include fields to capture Address 1, Address 2, City, State Country, Postal Code. You must separate each attribute into a distinct field.<br />
* Geocode Field Mapping must be established on your Level 2 object. The Geocode Field Mapping feature allows for the calculation of latitude and longitude based on addresses entered against level 2 custom fields.<br />
** Navigate to your UTA configuration settings, view the Level 2 object tab, and click on the the link labeled ''Geocode Field Mapping''.<br />
*** Define the Level 2 custom fields that will be used for each defined address component.<br />
[[File:L2AddressMapping1.png|thumb|none|800px|Address Mapping]]<br />
<br />
* In order for the Level 2 record to store the latitude and longitude for the location, the Level 2 record must be saved after the address details have been entered in the address custom fields. Alternatively, you may use a workflow on the Level 2 record that uses the 'Retrieve Latitude/Longitude' workflow task type. This workflow task will automatically calculate the latitude and longitude based on the custom field address values. The workflow must be triggered at a point in time after the address values have been entered in the Level 2 record.<br />
<br />
<br />
<br />
<br />
<br />
==Settings Explained==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Name<br />
||The name of the map you are creating.<br />
|-<br />
||Description<br />
||Used for storing additional detail about the map.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Status Filter<br />
||Filters the records being plotted on the map based on the record status.<br />
|-<br />
||Amount Field<br />
||The field that will be used in an aggregate sum displayed on the map (Grant Total: $###).<br />
|-<br />
||Zoom Level<br />
||The level of zoom defined for loading the page on the Zoom Center you select.<br />
|-<br />
||Zoom Center<br />
||The location on the map that the map will default in loading.<br />
|-<br />
||Auto Zoom<br />
||This option will automatically load the map zoomed in on the area where records exist. If selected, the Zoom Level and Zoom Center are not utilized.<br />
|-<br />
||Map Theme<br />
||The style of the map that will be displayed.<br />
|-<br />
||Marker URL<br />
||This can be utilized to reference an image file for use as the map markers in place of the default Google Maps marker. This is not required if you want to use the default marker.<br />
|-<br />
||Information Fields<br />
||Select the fields from the UTA record that you want displayed in the information box that will be displayed when selecting a marker on the map.<br />
|-<br />
||Information Template<br />
||This can be utilized if you plan to use a custom template for the Information Fields display on the map. This is not required.<br />
|-<br />
||KML<br />
||You can add references to KML files for your map so that KML overlays can be applied to the map. This is not required.<br />
|-<br />
||SmartFolder<br />
||You must select a SmartFolder where the map files will be stored to within your SmartSimple instance.<br />
|}<br />
<br />
=<br data-attributes="%20/">Impact Map Example=<br />
Theme: Default<br />
<br />
[[File:Map_Sample.png|thumb|none|1000px|Sample Impact Map Display.]]<br />
<br />
=<br data-attributes="%20/">Additional Map Theme Styles=<br />
Blue Water[[File:Blue_Water.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Facebook<br />
[[File:Facebook.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Light Grayscale<br />
[[File:Light_Grayscale.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Golden Brown<br />
[[File:Golden_Brown.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Retro<br />
[[File:Retro.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
[[Category:Tools]]<br />
[[Category:Geocoding]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Impact_Map&diff=37153Impact Map2019-10-09T15:17:36Z<p>DEardley: </p>
<hr />
<div>=Overview=<br />
The Impact Map is a feature that can be used to plot records from a UTA on a map interface to display locations from the UTA records.<br />
<br />
This feature provides a unique method for visualizing your data using geomapping functionality, commonly used for displaying locations of grant impact.<br />
<br />
In order to configure an Impact Map, you will need administrator access to the UTA that will be used for generating the locations on the map.<br />
<br />
=Configuration - Essentials=<br />
* Choose the UTA the map will be associated with based on the types of records you want to present on the map.<br />
* An Impact Map can be created using either Level 1 or Level 2 records in the UTA. <br />
** Level 1 records will be displayed on the Impact Map using the location of the organization (client) associated to the record.<br />
** Level 2 records may be displayed on the Impact Map using a unique address that will be defined using Geocode Field Mapping settings. See 'Configuration - Advanced' for additional steps that are required.<br />
* In order for records to be plotted on the map, the use of the standard fields 'Latitude' and 'Longitude' must be enabled on your records. Review your records' standard fields, and enable these fields if not completed previously.<br />
** Note: The values for Latitude and Longitude must be stored to the record by either saving the record or using the 'Retrieve Latitude/Longitude' workflow task type.<br />
* In the UTA Settings, go to the Level 2 tab and select the 'Impact Map Settings' link. <br />
** Create a new map using the (+) button in the menu. Enter the map settings details based on the available parameters.<br />
** Once you have entered all of the settings for the map, save the map. <br />
** Click the 'Generate HTML and JSON files' button to create the required files that will be stored to your selected SmartFolder. The HTML file URL will be accessible in the Impact Map configuration page. This can be referenced for navigating to the map, and can be utilized in portal design by referencing the relative URL in a custom page or custom portal section (Example: /files/368847/f304276/11_impactmap.html).<br />
<br />
=Configuration - Advanced=<br />
If you are creating an Impact Map using Level 2 records, you will need to take several additional steps that are not required for Level 1 record maps.<br />
<br />
* Ensure that the 'Latitude' and 'Longitude' standard fields are enabled on your Level 2 object in your UTA. Navigate to your Standard Fields list for your Level 2 object and save the 'Latitude' and 'Longitude' fields if they have not been enabled previously.<br />
* Create custom fields on your Level 2 object for storing the address that will be plotted on the Impact Map. These may include fields to capture Address 1, Address 2, City, State Country, Postal Code. You must separate each attribute into a distinct field.<br />
* Geocode Field Mapping must be established on your Level 2 object. The Geocode Field Mapping feature allows for the calculation of latitude and longitude based on addresses entered against level 2 custom fields.<br />
** Navigate to your UTA configuration settings, view the Level 2 object tab, and click on the the link labeled ''Geocode Field Mapping''.<br />
*** Define the Level 2 custom fields that will be used for each defined address component.<br />
[[File:L2AddressMapping1.png|thumb|none|800px|Address Mapping]]<br />
<br />
* In order for the Level 2 record to store the latitude and longitude for the location, the Level 2 record must be saved after the address details have been entered in the address custom fields. Alternatively, you may use a workflow on the Level 2 record that uses the 'Retrieve Latitude/Longitude' workflow task type. This workflow task will automatically calculate the latitude and longitude based on the custom field address values. The workflow must be triggered at a point in time after the address values have been entered in the Level 2 record.<br />
<br />
<br />
<br />
<br />
<br />
==Settings Explained==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Name<br />
||The name of the map you are creating.<br />
|-<br />
||Description<br />
||Used for storing additional detail about the map.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Status Filter<br />
||Filters the records being plotted on the map based on the record status.<br />
|-<br />
||Amount Field<br />
||The field that will be used in an aggregate sum displayed on the map (Grant Total: $###).<br />
|-<br />
||Zoom Level<br />
||The level of zoom defined for loading the page on the Zoom Center you select.<br />
|-<br />
||Zoom Center<br />
||The location on the map that the map will default in loading.<br />
|-<br />
||Auto Zoom<br />
||This option will automatically load the map zoomed in on the area where records exist. If selected, the Zoom Level and Zoom Center are not utilized.<br />
|-<br />
||Map Theme<br />
||The style of the map that will be displayed.<br />
|-<br />
||Marker URL<br />
||This can be utilized to reference an image file for use as the map markers in place of the default Google Maps marker. This is not required if you want to use the default marker.<br />
|-<br />
||Information Fields<br />
||Select the fields from the UTA record that you want displayed in the information box that will be displayed when selecting a marker on the map.<br />
|-<br />
||Information Template<br />
||This can be utilized if you plan to use a custom template for the Information Fields display on the map. This is not required.<br />
|-<br />
||KML<br />
||You can add references to KML files for your map so that KML overlays can be applied to the map. This is not required.<br />
|-<br />
||SmartFolder<br />
||You must select a SmartFolder where the map files will be stored to within your SmartSimple instance.<br />
|}<br />
<br />
=<br data-attributes="%20/">Impact Map Example=<br />
Theme: Default<br />
<br />
[[File:Map_Sample.png|thumb|none|1000px|Sample Impact Map Display.]]<br />
<br />
=<br data-attributes="%20/">Additional Map Theme Styles=<br />
Blue Water[[File:Blue_Water.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Facebook<br />
[[File:Facebook.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Light Grayscale<br />
[[File:Light_Grayscale.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Golden Brown<br />
[[File:Golden_Brown.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Retro<br />
[[File:Retro.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
[[Category:Tools]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Impact_Map&diff=37152Impact Map2019-10-09T15:15:36Z<p>DEardley: /* Configuration - Advanced */</p>
<hr />
<div>=Overview=<br />
The Impact Map is a feature that can be used to plot records from a UTA on a map interface to display locations from the UTA records.<br />
<br />
This feature provides a unique method for visualizing your data using geomapping functionality, commonly used for displaying locations of grant impact.<br />
<br />
In order to configure an Impact Map, you will need administrator access to the UTA that will be used for generating the locations on the map.<br />
<br />
=Configuration - Essentials=<br />
* Choose the UTA the map will be associated with based on the types of records you want to present on the map.<br />
* An Impact Map can be created using either Level 1 or Level 2 records in the UTA. <br />
** Level 1 records will be displayed on the Impact Map using the location of the organization (client) associated to the record.<br />
** Level 2 records may be displayed on the Impact Map using a unique address that will be defined using Geocode Field Mapping settings. See 'Configuration - Advanced' for additional steps that are required.<br />
* In order for records to be plotted on the map, the use of the standard fields 'Latitude' and 'Longitude' must be enabled on your records. Review your records' standard fields, and enable these fields if not completed previously.<br />
** Note: The values for Latitude and Longitude must be stored to the record by either saving the record or using the 'Retrieve Latitude/Longitude' workflow task type.<br />
* In the UTA Settings, go to the Level 2 tab and select the 'Impact Map Settings' link. <br />
** Create a new map using the (+) button in the menu. Enter the map settings details based on the available parameters.<br />
** Once you have entered all of the settings for the map, save the map. <br />
** Click the 'Generate HTML and JSON files' button to create the required files that will be stored to your selected SmartFolder. The HTML file URL will be accessible in the Impact Map configuration page. This can be referenced for navigating to the map, and can be utilized in portal design by referencing the relative URL in a custom page or custom portal section (Example: /files/368847/f304276/11_impactmap.html).<br />
<br />
=Configuration - Advanced=<br />
If you are creating an Impact Map using Level 2 records, you will need to take several additional steps that are not required for Level 1 record maps.<br />
<br />
* Ensure that the 'Latitude' and 'Longitude' standard fields are enabled on your Level 2 object in your UTA. Navigate to your Standard Fields list for your Level 2 object and save the 'Latitude' and 'Longitude' fields if they have not been enabled previously.<br />
* Create custom fields on your Level 2 object for storing the address that will be plotted on the Impact Map. These may include fields to capture Address 1, Address 2, City, State Country, Postal Code. You must separate each attribute into a distinct field.<br />
* Geocode Field Mapping must be established on your Level 2 object. The Geocode Field Mapping feature allows for the calculation of latitude and longitude based on addresses entered against level 2 custom fields.<br />
** Navigate to your UTA configuration settings, view the Level 2 object tab, and click on the the link labeled ''Geocode Field Mapping''.<br />
*** Define the Level 2 custom fields that will be used for each defined address component.<br />
[[File:L2AddressMapping1.png|thumb|none|800px|Address Mapping]]<br />
<br />
* In order for the Level 2 record to store the latitude and longitude for the location, the Level 2 record must be saved after the address details have been entered in the address custom fields. Alternatively, you may use a workflow on the Level 2 record that uses the 'Retrieve Latitude/Longitude' workflow task type. This workflow task will automatically calculate the latitude and longitude based on the custom field address values. The workflow must be triggered at a point in time after the address values have been entered in the Level 2 record.<br />
<br />
<br />
<br />
<br />
<br />
==Settings Explained==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Name<br />
||The name of the map you are creating.<br />
|-<br />
||Description<br />
||Used for storing additional detail about the map.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Status Filter<br />
||Filters the records being plotted on the map based on the record status.<br />
|-<br />
||Amount Field<br />
||The field that will be used in an aggregate sum displayed on the map (Grant Total: $###).<br />
|-<br />
||Zoom Level<br />
||The level of zoom defined for loading the page on the Zoom Center you select.<br />
|-<br />
||Zoom Center<br />
||The location on the map that the map will default in loading.<br />
|-<br />
||Auto Zoom<br />
||This option will automatically load the map zoomed in on the area where records exist. If selected, the Zoom Level and Zoom Center are not utilized.<br />
|-<br />
||Map Theme<br />
||The style of the map that will be displayed.<br />
|-<br />
||Marker URL<br />
||This can be utilized to reference an image file for use as the map markers in place of the default Google Maps marker. This is not required if you want to use the default marker.<br />
|-<br />
||Information Fields<br />
||Select the fields from the UTA record that you want displayed in the information box that will be displayed when selecting a marker on the map.<br />
|-<br />
||Information Template<br />
||This can be utilized if you plan to use a custom template for the Information Fields display on the map. This is not required.<br />
|-<br />
||KML<br />
||You can add references to KML files for your map so that KML overlays can be applied to the map. This is not required.<br />
|-<br />
||SmartFolder<br />
||You must select a SmartFolder where the map files will be stored to within your SmartSimple instance.<br />
|}<br />
<br />
=<br data-attributes="%20/">Impact Map Example=<br />
Theme: Default<br />
<br />
[[File:Map_Sample.png|thumb|none|1000px|Sample Impact Map Display.]]<br />
<br />
=<br data-attributes="%20/">Additional Map Theme Styles=<br />
Blue Water[[File:Blue_Water.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Facebook<br />
[[File:Facebook.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Light Grayscale<br />
[[File:Light_Grayscale.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Golden Brown<br />
[[File:Golden_Brown.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Retro<br />
[[File:Retro.png|thumb|none|500px|Sample Impact Map Display.]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Impact_Map&diff=37151Impact Map2019-10-09T15:15:09Z<p>DEardley: </p>
<hr />
<div>=Overview=<br />
The Impact Map is a feature that can be used to plot records from a UTA on a map interface to display locations from the UTA records.<br />
<br />
This feature provides a unique method for visualizing your data using geomapping functionality, commonly used for displaying locations of grant impact.<br />
<br />
In order to configure an Impact Map, you will need administrator access to the UTA that will be used for generating the locations on the map.<br />
<br />
=Configuration - Essentials=<br />
* Choose the UTA the map will be associated with based on the types of records you want to present on the map.<br />
* An Impact Map can be created using either Level 1 or Level 2 records in the UTA. <br />
** Level 1 records will be displayed on the Impact Map using the location of the organization (client) associated to the record.<br />
** Level 2 records may be displayed on the Impact Map using a unique address that will be defined using Geocode Field Mapping settings. See 'Configuration - Advanced' for additional steps that are required.<br />
* In order for records to be plotted on the map, the use of the standard fields 'Latitude' and 'Longitude' must be enabled on your records. Review your records' standard fields, and enable these fields if not completed previously.<br />
** Note: The values for Latitude and Longitude must be stored to the record by either saving the record or using the 'Retrieve Latitude/Longitude' workflow task type.<br />
* In the UTA Settings, go to the Level 2 tab and select the 'Impact Map Settings' link. <br />
** Create a new map using the (+) button in the menu. Enter the map settings details based on the available parameters.<br />
** Once you have entered all of the settings for the map, save the map. <br />
** Click the 'Generate HTML and JSON files' button to create the required files that will be stored to your selected SmartFolder. The HTML file URL will be accessible in the Impact Map configuration page. This can be referenced for navigating to the map, and can be utilized in portal design by referencing the relative URL in a custom page or custom portal section (Example: /files/368847/f304276/11_impactmap.html).<br />
<br />
=Configuration - Advanced=<br />
If you are creating an Impact Map using Level 2 records, you will need to take several additional steps that are not required for Level 1 record maps.<br />
<br />
* Ensure that the 'Latitude' and 'Longitude' standard fields are enabled on your Level 2 object in your UTA. Navigate to your Standard Fields list for your Level 2 object and save the 'Latitude' and 'Longitude' fields if they have not been enabled previously.<br />
* Create custom fields on your Level 2 object for storing the address that will be plotted on the Impact Map. These may include fields to capture Address 1, Address 2, City, State Country, Postal Code. You must separate each attribute into a distinct field.<br />
* Geocode Field Mapping must be established on your Level 2 object. The Geocode Field Mapping feature allows for the calculation of latitude and longitude based on addresses entered against level 2 custom fields.<br />
** Navigate to your UTA configuration settings, view the Level 2 object tab, and click on the the link labeled ''Geocode Field Mapping''.<br />
*** Define the Level 2 custom fields that will be used for each defined address component.<br />
[[File:L2AddressMapping1.png|thumb|none|500px|Address Mapping]]<br />
<br />
* In order for the Level 2 record to store the latitude and longitude for the location, the Level 2 record must be saved after the address details have been entered in the address custom fields. Alternatively, you may use a workflow on the Level 2 record that uses the 'Retrieve Latitude/Longitude' workflow task type. This workflow task will automatically calculate the latitude and longitude based on the custom field address values. The workflow must be triggered at a point in time after the address values have been entered in the Level 2 record.<br />
<br />
<br />
<br />
<br />
<br />
==Settings Explained==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Name<br />
||The name of the map you are creating.<br />
|-<br />
||Description<br />
||Used for storing additional detail about the map.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Status Filter<br />
||Filters the records being plotted on the map based on the record status.<br />
|-<br />
||Amount Field<br />
||The field that will be used in an aggregate sum displayed on the map (Grant Total: $###).<br />
|-<br />
||Zoom Level<br />
||The level of zoom defined for loading the page on the Zoom Center you select.<br />
|-<br />
||Zoom Center<br />
||The location on the map that the map will default in loading.<br />
|-<br />
||Auto Zoom<br />
||This option will automatically load the map zoomed in on the area where records exist. If selected, the Zoom Level and Zoom Center are not utilized.<br />
|-<br />
||Map Theme<br />
||The style of the map that will be displayed.<br />
|-<br />
||Marker URL<br />
||This can be utilized to reference an image file for use as the map markers in place of the default Google Maps marker. This is not required if you want to use the default marker.<br />
|-<br />
||Information Fields<br />
||Select the fields from the UTA record that you want displayed in the information box that will be displayed when selecting a marker on the map.<br />
|-<br />
||Information Template<br />
||This can be utilized if you plan to use a custom template for the Information Fields display on the map. This is not required.<br />
|-<br />
||KML<br />
||You can add references to KML files for your map so that KML overlays can be applied to the map. This is not required.<br />
|-<br />
||SmartFolder<br />
||You must select a SmartFolder where the map files will be stored to within your SmartSimple instance.<br />
|}<br />
<br />
=<br data-attributes="%20/">Impact Map Example=<br />
Theme: Default<br />
<br />
[[File:Map_Sample.png|thumb|none|1000px|Sample Impact Map Display.]]<br />
<br />
=<br data-attributes="%20/">Additional Map Theme Styles=<br />
Blue Water[[File:Blue_Water.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Facebook<br />
[[File:Facebook.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Light Grayscale<br />
[[File:Light_Grayscale.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Golden Brown<br />
[[File:Golden_Brown.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Retro<br />
[[File:Retro.png|thumb|none|500px|Sample Impact Map Display.]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Impact_Map&diff=37150Impact Map2019-10-09T15:12:56Z<p>DEardley: </p>
<hr />
<div>=Overview=<br />
The Impact Map is a feature that can be used to plot records from a UTA on a map interface to display locations from the UTA records.<br />
<br />
This feature provides a unique method for visualizing your data using geomapping functionality, commonly used for displaying locations of grant impact.<br />
<br />
In order to configure an Impact Map, you will need administrator access to the UTA that will be used for generating the locations on the map.<br />
<br />
=Configuration - Essentials=<br />
* Choose the UTA the map will be associated with based on the types of records you want to present on the map.<br />
* An Impact Map can be created using either Level 1 or Level 2 records in the UTA. <br />
** Level 1 records will be displayed on the Impact Map using the location of the organization (client) associated to the record.<br />
** Level 2 records may be displayed on the Impact Map using a unique address that will be defined using Geocode Field Mapping settings. See 'Configuration - Advanced' for additional steps that are required.<br />
* In order for records to be plotted on the map, the use of the standard fields 'Latitude' and 'Longitude' must be enabled on your records. Review your records' standard fields, and enable these fields if not completed previously.<br />
** Note: The values for Latitude and Longitude must be stored to the record by either saving the record or using the 'Retrieve Latitude/Longitude' workflow task type.<br />
* In the UTA Settings, go to the Level 2 tab and select the 'Impact Map Settings' link. <br />
** Create a new map using the (+) button in the menu. Enter the map settings details based on the available parameters.<br />
** Once you have entered all of the settings for the map, save the map. <br />
** Click the 'Generate HTML and JSON files' button to create the required files that will be stored to your selected SmartFolder. The HTML file URL will be accessible in the Impact Map configuration page. This can be referenced for navigating to the map, and can be utilized in portal design by referencing the relative URL in a custom page or custom portal section (Example: /files/368847/f304276/11_impactmap.html).<br />
<br />
=Configuration - Advanced=<br />
If you are creating an Impact Map using Level 2 records, you will need to take several additional steps that are not required for Level 1 record maps.<br />
<br />
* Ensure that the 'Latitude' and 'Longitude' standard fields are enabled on your Level 2 object in your UTA. Navigate to your Standard Fields list for your Level 2 object and save the 'Latitude' and 'Longitude' fields if they have not been enabled previously.<br />
* Create custom fields on your Level 2 object for storing the address that will be plotted on the Impact Map. These may include fields to capture Address 1, Address 2, City, State Country, Postal Code. You must separate each attribute into a distinct field.<br />
* Geocode Field Mapping must be established on your Level 2 object. The Geocode Field Mapping feature allows for the calculation of latitude and longitude based on addresses entered against level 2 custom fields.<br />
** Navigate to your UTA configuration settings, view the Level 2 object tab, and click on the the link labeled ''Geocode Field Mapping''.<br />
*** Define the Level 2 custom fields that will be used for each defined address component.<br />
[[Image:L2AddressMapping1.png]]<br />
<br />
* In order for the Level 2 record to store the latitude and longitude for the location, the Level 2 record must be saved after the address details have been entered in the address custom fields. Alternatively, you may use a workflow on the Level 2 record that uses the 'Retrieve Latitude/Longitude' workflow task type. This workflow task will automatically calculate the latitude and longitude based on the custom field address values. The workflow must be triggered at a point in time after the address values have been entered in the Level 2 record.<br />
<br />
<br />
<br />
<br />
<br />
==Settings Explained==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Name<br />
||The name of the map you are creating.<br />
|-<br />
||Description<br />
||Used for storing additional detail about the map.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Status Filter<br />
||Filters the records being plotted on the map based on the record status.<br />
|-<br />
||Amount Field<br />
||The field that will be used in an aggregate sum displayed on the map (Grant Total: $###).<br />
|-<br />
||Zoom Level<br />
||The level of zoom defined for loading the page on the Zoom Center you select.<br />
|-<br />
||Zoom Center<br />
||The location on the map that the map will default in loading.<br />
|-<br />
||Auto Zoom<br />
||This option will automatically load the map zoomed in on the area where records exist. If selected, the Zoom Level and Zoom Center are not utilized.<br />
|-<br />
||Map Theme<br />
||The style of the map that will be displayed.<br />
|-<br />
||Marker URL<br />
||This can be utilized to reference an image file for use as the map markers in place of the default Google Maps marker. This is not required if you want to use the default marker.<br />
|-<br />
||Information Fields<br />
||Select the fields from the UTA record that you want displayed in the information box that will be displayed when selecting a marker on the map.<br />
|-<br />
||Information Template<br />
||This can be utilized if you plan to use a custom template for the Information Fields display on the map. This is not required.<br />
|-<br />
||KML<br />
||You can add references to KML files for your map so that KML overlays can be applied to the map. This is not required.<br />
|-<br />
||SmartFolder<br />
||You must select a SmartFolder where the map files will be stored to within your SmartSimple instance.<br />
|}<br />
<br />
=<br data-attributes="%20/">Impact Map Example=<br />
Theme: Default<br />
<br />
[[File:Map_Sample.png|thumb|none|1000px|Sample Impact Map Display.]]<br />
<br />
=<br data-attributes="%20/">Additional Map Theme Styles=<br />
Blue Water[[File:Blue_Water.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Facebook<br />
[[File:Facebook.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Light Grayscale<br />
[[File:Light_Grayscale.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Golden Brown<br />
[[File:Golden_Brown.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Retro<br />
[[File:Retro.png|thumb|none|500px|Sample Impact Map Display.]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Impact_Map&diff=37149Impact Map2019-10-09T14:58:51Z<p>DEardley: /* Configuration - Essentials */</p>
<hr />
<div>=Overview=<br />
The Impact Map is a feature that can be used to plot records from a UTA on a map interface to display locations from the UTA records.<br />
<br />
This feature provides a unique method for visualizing your data using geomapping functionality, commonly used for displaying locations of grant impact.<br />
<br />
In order to configure an Impact Map, you will need administrator access to the UTA that will be used for generating the locations on the map.<br />
<br />
=Configuration - Essentials=<br />
* Choose the UTA the map will be associated with based on the types of records you want to present on the map.<br />
* An Impact Map can be created using either Level 1 or Level 2 records in the UTA. <br />
** Level 1 records will be displayed on the Impact Map using the location of the organization (client) associated to the record.<br />
** Level 2 records may be displayed on the Impact Map using a unique address that will be defined using Geocode Field Mapping settings. See 'Configuration - Advanced' for additional steps that are required.<br />
* In order for records to be plotted on the map, the use of the standard fields 'Latitude' and 'Longitude' must be enabled on your records. Review your records' standard fields, and enable these fields if not completed previously.<br />
** Note: The values for Latitude and Longitude must be stored to the record by either saving the record or using the 'Retrieve Latitude/Longitude' workflow task type.<br />
* In the UTA Settings, go to the Level 2 tab and select the 'Impact Map Settings' link. <br />
** Create a new map using the (+) button in the menu. Enter the map settings details based on the available parameters.<br />
** Once you have entered all of the settings for the map, save the map. <br />
** Click the 'Generate HTML and JSON files' button to create the required files that will be stored to your selected SmartFolder. The HTML file URL will be accessible in the Impact Map configuration page. This can be referenced for navigating to the map, and can be utilized in portal design by referencing the relative URL in a custom page or custom portal section (Example: /files/368847/f304276/11_impactmap.html).<br />
<br />
<br />
<br />
==Settings Explained==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Name<br />
||The name of the map you are creating.<br />
|-<br />
||Description<br />
||Used for storing additional detail about the map.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Status Filter<br />
||Filters the records being plotted on the map based on the record status.<br />
|-<br />
||Amount Field<br />
||The field that will be used in an aggregate sum displayed on the map (Grant Total: $###).<br />
|-<br />
||Zoom Level<br />
||The level of zoom defined for loading the page on the Zoom Center you select.<br />
|-<br />
||Zoom Center<br />
||The location on the map that the map will default in loading.<br />
|-<br />
||Auto Zoom<br />
||This option will automatically load the map zoomed in on the area where records exist. If selected, the Zoom Level and Zoom Center are not utilized.<br />
|-<br />
||Map Theme<br />
||The style of the map that will be displayed.<br />
|-<br />
||Marker URL<br />
||This can be utilized to reference an image file for use as the map markers in place of the default Google Maps marker. This is not required if you want to use the default marker.<br />
|-<br />
||Information Fields<br />
||Select the fields from the UTA record that you want displayed in the information box that will be displayed when selecting a marker on the map.<br />
|-<br />
||Information Template<br />
||This can be utilized if you plan to use a custom template for the Information Fields display on the map. This is not required.<br />
|-<br />
||KML<br />
||You can add references to KML files for your map so that KML overlays can be applied to the map. This is not required.<br />
|-<br />
||SmartFolder<br />
||You must select a SmartFolder where the map files will be stored to within your SmartSimple instance.<br />
|}<br />
<br />
=<br data-attributes="%20/">Impact Map Example=<br />
Theme: Default<br />
<br />
[[File:Map_Sample.png|thumb|none|1000px|Sample Impact Map Display.]]<br />
<br />
=<br data-attributes="%20/">Additional Map Theme Styles=<br />
Blue Water[[File:Blue_Water.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Facebook<br />
[[File:Facebook.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Light Grayscale<br />
[[File:Light_Grayscale.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Golden Brown<br />
[[File:Golden_Brown.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Retro<br />
[[File:Retro.png|thumb|none|500px|Sample Impact Map Display.]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Impact_Map&diff=37148Impact Map2019-10-09T14:55:50Z<p>DEardley: </p>
<hr />
<div>=Overview=<br />
The Impact Map is a feature that can be used to plot records from a UTA on a map interface to display locations from the UTA records.<br />
<br />
This feature provides a unique method for visualizing your data using geomapping functionality, commonly used for displaying locations of grant impact.<br />
<br />
In order to configure an Impact Map, you will need administrator access to the UTA that will be used for generating the locations on the map.<br />
<br />
=Configuration - Essentials=<br />
* Choose the UTA the map will be associated with based on the types of records you want to present on the map. For this example, we will be using Level 2 records from a UTA, but the feature is also available on Level 1 records. <br />
* In order for records to be plotted on the map, the use of the standard fields 'Latitude' and 'Longitude' must be enabled on your records. Review your records' standard fields, and enable these fields if not completed previously.<br />
* You can define the Latitude and Longitude field values by utilizing the Geocode Field Mapping feature detailed on the [[Configuring_the_Level_2_Entity]] page.<br />
** Note: The values for Latitude and Longitude must be stored to the record by either saving the record or using the 'Retrieve Latitude/Longitude' workflow task type.<br />
* In the UTA Settings, go to the Level 2 tab and select the 'Impact Map Settings' link. <br />
** Create a new map using the (+) button in the menu. Enter the map settings details based on the available parameters.<br />
** Once you have entered all of the settings for the map, save the map. <br />
** Click the 'Generate HTML and JSON files' button to create the required files that will be stored to your selected SmartFolder. The HTML file URL will be accessible in the Impact Map configuration page. This can be referenced for navigating to the map, and can be utilized in portal design by referencing the relative URL in a custom page or custom portal section (Example: /files/368847/f304276/11_impactmap.html).<br />
<br />
<br />
==Settings Explained==<br />
{| class="contenttable" style="height: 170px;" border=".5" width="1208"<br />
|-<br />
||Setting<br />
||Description <br />
|-<br />
||Name<br />
||The name of the map you are creating.<br />
|-<br />
||Description<br />
||Used for storing additional detail about the map.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Type Filter<br />
||Filters the records being plotted on the map based on the record type.<br />
|-<br />
||Status Filter<br />
||Filters the records being plotted on the map based on the record status.<br />
|-<br />
||Amount Field<br />
||The field that will be used in an aggregate sum displayed on the map (Grant Total: $###).<br />
|-<br />
||Zoom Level<br />
||The level of zoom defined for loading the page on the Zoom Center you select.<br />
|-<br />
||Zoom Center<br />
||The location on the map that the map will default in loading.<br />
|-<br />
||Auto Zoom<br />
||This option will automatically load the map zoomed in on the area where records exist. If selected, the Zoom Level and Zoom Center are not utilized.<br />
|-<br />
||Map Theme<br />
||The style of the map that will be displayed.<br />
|-<br />
||Marker URL<br />
||This can be utilized to reference an image file for use as the map markers in place of the default Google Maps marker. This is not required if you want to use the default marker.<br />
|-<br />
||Information Fields<br />
||Select the fields from the UTA record that you want displayed in the information box that will be displayed when selecting a marker on the map.<br />
|-<br />
||Information Template<br />
||This can be utilized if you plan to use a custom template for the Information Fields display on the map. This is not required.<br />
|-<br />
||KML<br />
||You can add references to KML files for your map so that KML overlays can be applied to the map. This is not required.<br />
|-<br />
||SmartFolder<br />
||You must select a SmartFolder where the map files will be stored to within your SmartSimple instance.<br />
|}<br />
<br />
=<br data-attributes="%20/">Impact Map Example=<br />
Theme: Default<br />
<br />
[[File:Map_Sample.png|thumb|none|1000px|Sample Impact Map Display.]]<br />
<br />
=<br data-attributes="%20/">Additional Map Theme Styles=<br />
Blue Water[[File:Blue_Water.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Facebook<br />
[[File:Facebook.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Light Grayscale<br />
[[File:Light_Grayscale.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Golden Brown<br />
[[File:Golden_Brown.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Retro<br />
[[File:Retro.png|thumb|none|500px|Sample Impact Map Display.]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Configuring_the_Level_2_Entity&diff=36836Configuring the Level 2 Entity2019-08-15T14:27:14Z<p>DEardley: /* Address Mapping */</p>
<hr />
<div>==Configuring the Level 2 Entity==<br />
<br />
1. Click on the '''Settings''' menu, [[UTA Settings - Entity]] link.<br />
<br />
2. Scroll to the '''Activity Settings''' section of the page.<br />
<br />
:[[Image:UTAEntitySetting2.png]]<br />
<br />
The [[Level 2 Entity]] will consist of:<br />
* '''Standard fields''' relabeled to suit the application.<br />
* [[Custom Field|Custom fields]] that will be associated with all Level 1 items.<br />
* '''Inherit Custom Fields''' – Provides the ability to create Level 2 item custom fields that are only available based on the selected Level 1 template.<br />
* '''Level 1 Contact Assignments''' – Restrict the people that can be associated with a Level 2 activity to only those associated with the Level 1 item. <br />
* '''Auto Assign People''' – Automatically assign people associated with the Level 1 item to all Level 2 activities.<br />
* An optional '''Reader Log''' that will track every time a user displays the Level 2 item and the amount of time that they review that item. This is a privacy audit feature that can be enabled in sensitive applications. The user will not be aware of their display of the item. This feature is used in conjunction with the '''Manager Permission – View Reader Log'''.<br />
<br />
3. Click the '''Standard Fields''' link.<br />
<br />
The Standard field list is displayed.<br />
<br />
{{StandardFieldEditPageL2}}<br />
<br />
==Level 2 Standard Field Features==<br />
<br />
This screen works in a similar manner to the Level 1 standard field list.<br />
* '''Adding a field''' – Click on the standard field name on the left-hand list of standard fields. A default caption will appear. Scroll to the bottom of the page and hit "Save."<br />
* '''Adding and renaming a field''' – Type a new caption for the field in the caption box.<br />
* '''Removing a field''' – Click on the standard field name on the left-hand list of standard fields. Scroll to the bottom of the page and hit "Delete."<br />
* '''To provide mouse over help on a field''' – Type the help in the "Tool Tip" box.<br />
* Clicking the '''Mandatory''' check box will make the field required before the record can be saved.<br />
<br />
==Standard Level 2 Field List==<br />
<br />
{{Level2StandardFieldList}}<br />
<br />
==Selecting the Activity fields==<br />
<br />
1. Configure the following '''Activity Fields''':<br />
<br />
[[Image:L2StandardFieldExample.png|link=|250px]]<br />
<br />
Not all activity fields are shown in this screen – only the ones that you need to set.<br />
* The '''parent name''' field is not being used, as the contract Level 1 name does not have a name.<br />
* The '''Amount''' field is not being used as the amount is not a property of all Level 2 items, but only a property of the invoice type entity.<br />
<br />
2. Click the '''Save''' button.<br />
<br />
3. Click the '''Edit Application''' tab to return to the '''Configuration''' window.<br />
<br />
==Setting the Level 2 settings==<br />
<br />
Generally, at this stage you would add the [[Custom Field|custom fields]] required for all [[Level 2 Entity|Level 2 entities]], but in this case you will only add custom fields to the type of '''Level 2 Entity – Invoice'''. This technique provides more flexibility as the generic [[Level 2 Entity]] does not contain any specific fields.<br />
<br />
1. Click the '''Settings''' tab.<br />
<br />
2. Scroll to the '''Activity Settings''' Section.<br />
<br />
[[Image:L2settings.png|link=]]<br />
<br />
This panel is used to set:<br />
* '''Custom fields''' – Common to all Level 1 items.<br />
* '''[[List View]]''' – The fields and order required for the Level 2 list view.<br />
* '''[[Types]]''' – The types of Level 2 items required (the equivalent to [[Level 1 Templates]]).<br />
* '''[[Statuses]]''' – The statuses required for the Level 2 items. In addition to these links you can also enable the following Level 2 options:<br />
* '''Use Current Time for Activities''' – This option defaults the time fields to the current time. This option is only applicable if you are using the Level 2 time fields.<br />
* '''Enable Time Filtering''' – Displays From and To time fields on the Level 2 list view.<br />
* '''Open Activity in Full Application Screen''' – When clicking on a Level 2 item at the bottom of the Level 1 item, this option displays the Level 2 item in the full window. If you don’t use this option the Level 2 item will be displayed below the Level 1 in the same window.<br />
* '''Open Activity in New Window''' – Displays the Level 2 item in a separate window. The Level 1 item is still displayed.<br />
<br />
3. Click the '''Open Activity in Full Screen''' check box.<br />
<br />
4. Click the '''Save''' button.<br />
<br />
<br />
==Geocode Field Mapping (Address Mapping)==<br />
The Address Mapping feature allows for the calculation of latitude and longitude based on addresses entered against level 2 custom fields.<br />
<br />
The first step is to access the [[Standard_Level_2_Field_List|Level 2 Standard fields]] and enable the options for latitude and longitudes.<br />
<br />
The next steps click on the the link called ''Geocode Field Mapping'' within the UTA Settings page and to map the level 2 custom fields to address fields.<br />
<br />
: [[Image:L2AddressMapping1.png]]<br />
Then when you access a level 2 record, populate the Address specific custom fields and click Save then the latitude and longitude should be updated accordingly.<br />
<br />
==See Also==<br />
* [[UTA Settings - Settings|UTA Main Settings Page]]<br />
* [[UTA Standard Field Settings]]<br />
* [[Level 2 Types]]<br />
* [[Types]]<br />
<br />
[[Category:Universal Tracking Application]]<br />
<br />
<br />
{| cellpadding="5" style="background-color:#F0F0F0;border-style: solid; border-width: 2px"<br />
| [[Image:Previous.png|link=Working with Level 2 – Activities]] &nbsp;[[Working with Level 2 – Activities]]<br />
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br />
| [[Level 2 Types]] &nbsp;[[Image:Next.png|link=Level 2 Types]] <br />
|}</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Impact_Map&diff=36835Impact Map2019-08-15T14:12:56Z<p>DEardley: /* Impact Map Example */</p>
<hr />
<div>=Overview=<br />
The Impact Map is a feature that can be used to plot records from a UTA on a map interface to display locations from the UTA records.<br />
<br />
=Configuration=<br />
* Choose the UTA the map will be associated with based on the types of records you want to present on the map. For this example, we will be using Level 2 records from a UTA, but the feature is also available on Level 1 records. <br />
* In order for records to be plotted on the map, the use of the standard fields 'Latitude' and 'Longitude' must be enabled on your records. Review your records' standard fields, and enable these fields if not completed previously.<br />
* You can define the Latitude and Longitude field values by utilizing the Geocode Field Mapping feature detailed on the [[Configuring_the_Level_2_Entity]] page.<br />
** Note: The values for Latitude and Longitude must be stored to the record by either saving the record or using the 'Retrieve Latitude/Longitude' workflow task type.<br />
* In the UTA Settings, go to the Level 2 tab and select the 'Impact Map Settings' link. <br />
** Create a new map using the (+) button in the menu. Enter the map settings details based on the available parameters below.<br />
*** Name: The name of the map you are creating.<br />
*** Description: Used for storing additional detail about the map.<br />
*** Type Filter: Filters the records being plotted on the map based on the record type.<br />
*** Status Filter: Filters the records being plotted on the map based on the record status.<br />
*** Amount Field: The field that will be used in an aggregate sum displayed on the map (Grant Total: $###).<br />
*** Zoom Level: The level of zoom defined for loading the page on the Zoom Center you select.<br />
*** Zoom Center: The location on the map that the map will default in loading.<br />
*** Auto Zoom: This option will automatically load the map zoomed in on the area where records exist. If selected, the Zoom Level and Zoom Center are not utilized.<br />
*** Map Theme: The style of the map that will be displayed.<br />
*** Marker URL: This can be utilized to reference an image file for use as the map markers in place of the default Google Maps marker. This is not required if you want to use the default marker.<br />
*** Information Fields: Select the fields from the UTA record that you want displayed in the information box that will be displayed when selecting a marker on the map.<br />
*** Information Template: This can be utilized if you plan to use a custom template for the Information Fields display on the map. This is not required.<br />
*** KML: You can add references to KML files for your map so that KML overlays can be applied to the map. This is not required.<br />
*** SmartFolder: You must select a SmartFolder where the map files will be stored to within your SmartSimple instance.<br />
** Once you have entered all of the settings for the map, save the map. <br />
** Click the 'Generate HTML and JSON files' button to create the required files that will be stored to your selected SmartFolder. The HTML file URL will be accessible in the Impact Map configuration page. This can be referenced for navigating to the map, and can be utilized in portal design by referencing the relative URL in a custom page or custom portal section (Example: /files/368847/f304276/11_impactmap.html).<br />
<br />
=<br data-attributes="%20/">Impact Map Example=<br />
Theme: Default<br />
<br />
[[File:Map_Sample.png|thumb|none|1000px|Sample Impact Map Display.]]<br />
<br />
=<br data-attributes="%20/">Additional Map Theme Styles=<br />
Blue Water<br />
[[File:Blue_Water.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Facebook<br />
[[File:Facebook.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Light Grayscale<br />
[[File:Light_Grayscale.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Golden Brown<br />
[[File:Golden_Brown.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Retro<br />
[[File:Retro.png|thumb|none|500px|Sample Impact Map Display.]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=Impact_Map&diff=36834Impact Map2019-08-15T14:12:33Z<p>DEardley: /* Additional Map Theme Styles */</p>
<hr />
<div>=Overview=<br />
The Impact Map is a feature that can be used to plot records from a UTA on a map interface to display locations from the UTA records.<br />
<br />
=Configuration=<br />
* Choose the UTA the map will be associated with based on the types of records you want to present on the map. For this example, we will be using Level 2 records from a UTA, but the feature is also available on Level 1 records. <br />
* In order for records to be plotted on the map, the use of the standard fields 'Latitude' and 'Longitude' must be enabled on your records. Review your records' standard fields, and enable these fields if not completed previously.<br />
* You can define the Latitude and Longitude field values by utilizing the Geocode Field Mapping feature detailed on the [[Configuring_the_Level_2_Entity]] page.<br />
** Note: The values for Latitude and Longitude must be stored to the record by either saving the record or using the 'Retrieve Latitude/Longitude' workflow task type.<br />
* In the UTA Settings, go to the Level 2 tab and select the 'Impact Map Settings' link. <br />
** Create a new map using the (+) button in the menu. Enter the map settings details based on the available parameters below.<br />
*** Name: The name of the map you are creating.<br />
*** Description: Used for storing additional detail about the map.<br />
*** Type Filter: Filters the records being plotted on the map based on the record type.<br />
*** Status Filter: Filters the records being plotted on the map based on the record status.<br />
*** Amount Field: The field that will be used in an aggregate sum displayed on the map (Grant Total: $###).<br />
*** Zoom Level: The level of zoom defined for loading the page on the Zoom Center you select.<br />
*** Zoom Center: The location on the map that the map will default in loading.<br />
*** Auto Zoom: This option will automatically load the map zoomed in on the area where records exist. If selected, the Zoom Level and Zoom Center are not utilized.<br />
*** Map Theme: The style of the map that will be displayed.<br />
*** Marker URL: This can be utilized to reference an image file for use as the map markers in place of the default Google Maps marker. This is not required if you want to use the default marker.<br />
*** Information Fields: Select the fields from the UTA record that you want displayed in the information box that will be displayed when selecting a marker on the map.<br />
*** Information Template: This can be utilized if you plan to use a custom template for the Information Fields display on the map. This is not required.<br />
*** KML: You can add references to KML files for your map so that KML overlays can be applied to the map. This is not required.<br />
*** SmartFolder: You must select a SmartFolder where the map files will be stored to within your SmartSimple instance.<br />
** Once you have entered all of the settings for the map, save the map. <br />
** Click the 'Generate HTML and JSON files' button to create the required files that will be stored to your selected SmartFolder. The HTML file URL will be accessible in the Impact Map configuration page. This can be referenced for navigating to the map, and can be utilized in portal design by referencing the relative URL in a custom page or custom portal section (Example: /files/368847/f304276/11_impactmap.html).<br />
<br />
=<br data-attributes="%20/">Impact Map Example=<br />
[[File:Map_Sample.png|thumb|none|1000px|Sample Impact Map Display.]]<br />
<br />
<br />
=<br data-attributes="%20/">Additional Map Theme Styles=<br />
Blue Water<br />
[[File:Blue_Water.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Facebook<br />
[[File:Facebook.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Light Grayscale<br />
[[File:Light_Grayscale.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Golden Brown<br />
[[File:Golden_Brown.png|thumb|none|500px|Sample Impact Map Display.]]<br />
<br />
Retro<br />
[[File:Retro.png|thumb|none|500px|Sample Impact Map Display.]]</div>DEardleyhttps://wiki.smartsimple.com/index.php?title=File:Retro.png&diff=36833File:Retro.png2019-08-15T14:11:51Z<p>DEardley: </p>
<hr />
<div></div>DEardleyhttps://wiki.smartsimple.com/index.php?title=File:Light_Grayscale.png&diff=36832File:Light Grayscale.png2019-08-15T14:11:36Z<p>DEardley: </p>
<hr />
<div></div>DEardley