0
edits
Changes
no edit summary
== System Call Overview == The System Call feature of SmartSimple provides you with the ability to execute pre-defined system functions on the server and in the process avoid the creation of client side [[Custom Field Type: Special – Browser Script|scripting]]. The benefits of System Calls are as follows:
* Better performance and security as the execution of the code takes place on the server not in the client [[browser]].
* You don’t need to know [[JavaScript]] in order to use the feature.
== Using System Calls ==
When using system calls you add the System Call references to a [[Custom Field Type: Special – Browser Script|Browser Script]] custom field. The syntax for each System Call is as follows:
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><!--SysCall_function(@parameter 1@,@parameter 2@,@parameter N@)--></pre>
'''Note: ''' Multiple System calls can be embedded in the same script field.
== Triggering System Calls ==
The execution of the System Call is controlled by the trigger that you set for the [[Custom Field Type: Special – Browser Script|Browser Script]] field. The following triggers are supported.
* '''On Load''' - System Call is executed by the server when page is requested.
* '''On Demand''' - System Call is executed by the server when the user clicks a button on the page. :**The button will be displayed for the [[Custom Field Type: Special – Browser Script|Browser Script]] field when you select this type of trigger. :**Note that this is the only time the [[Custom Field Type: Special – Browser Script|Browser Script]] field type has any visibility on a page. **'''On Save''' - System Call is executed by the server when page is saved.
Note that [[Custom Field Type: Special – Browser Script|Browser Script]] fields triggered ''On Load'' or ''On Save'' can only use System Calls, not custom JavaScript, as they are processed server-side.
== System Call Examples ==
<pre><!--SysCall_updatestatus(@objtype@,@objid@,'StatusName')-->
<!--SysCall_workflow(@objtype@,@objid@,'myworkflow')-->
<!--SysCall_workflow(levelone,@parent.objid@,'myworkflow')--></pre>
**@objtype@ and @objid@ are reserved words. **Objtype can be referenced to the integer value associated with the entity type (23, 18, 30, 40) or constants can be used such as levelone, level1, leveltwo, level2, levelthree, level3, contact, people, company. See [[Entity IDs]] for complete list of entity types. ** Important: Ensure there are no spaces between parameters (i.e. before or after the commas)'''Note: ''' If, on an ''On Demand'' browser script, you are adding more JavaScript after the System Call, then add a semi-colon at the end of the system call to ensure that there are no script errors.
<pre><!--SysCall_workflow(@objtype@,@objid@,'myworkflow')-->;
alert("System call and alert work fine.");
'''On Demand''' system calls pass the button element to the function as parameter '''el'''. This can be used to disable the button or change the value to indicate when the function is complete. For example:
<pre>
<!--SysCall_workflow(@objtype@,@objid@,'Test Web Services')-->;
== Available System Calls ==
The following System Calls are currently in production
3 = Remove association.</pre>
<pre>SysCall_charitycheck(companyid)
Runs the SmartSimple GuideStar Charity Check procedure against the designated company.</pre>
Note: Please review the [[GuideStar Charity Check]] page for full information.
==Examples==
To have a button appear on the contact profile that will enable the user and add the '''Organization Contact''' Role:
*
*: [[File:Activate_sys_call.png|link=]]
** ''Note the visibility condition to ensure this button only appears on inactive contact records.''
** ''Also be sure to set as '''Hide for New Record''' since this will not work until the contact record has been saved the first time.''
To have a button appear on the contact profile that will disable the user:
* *: [[File:Deactivate_sys_call.png|link== Proposed Additional System Calls ==]]** ''Note the visibility condition to ensure this button only appears on active contacts, AND to prevent users from disabling their own account.''** ''Also be sure to set as '''Hide for New Record''' since this will not work until the contact record has been saved the first time.''
==Proposed Additional System Calls==We welcome suggestions for additional system calls that would reduce the need for scripting, so please email [mailto:support@smartsimple.com SmartSimple Support] or open a support ticket with [[How_the_SmartSimple_Support_Desk_Works|SmartSimple Support]] with the details of the System Call you would like to add. New proposed System Calls will be added to this article as they become available.
[[Category:JavaScript]]