Difference between revisions of "Creating SmartConnect Functions"

Revision as of 14:41, 27 August 2018

SmartConnect functions are specific to individual copies of SmartSimple so you can only use the functions that are have been previously established in that copy. The article describes how you add functions to an instance.

Creating a New Function

You need to have Global User Administrator permissions in order to add JSON functions.

Log into the copy of SmartSimple where you wish to add the function.
Navigate to Global Settings.
Click on the Integrations tab.
Click on the SmartConnect API link. Existing functions will be listed here for you to update.
Click on the + button to create a new function.

Function Settings

Each function has the following settings:

Function Name – you will use this name to call the function from your own code.
Description – used to provide documentation as to the function’s purpose.
Record Type – a list of all SmartSimple objects within this instance. This will include: Report (reports you have created in the instance), Organization (company records), Users (system users and contacts), and each Universal Tracking Application™ Level 1, Level 2 and Level 3 type that you have created in the instance.
Action Type – this defines the action to be taken by the function. The following actions are available: GET META, UPDATE META, GET, LIST, UPDATE, UPDATE ASSOCIATIONS, LIST ASSOCIATIONS, DOWNLOAD FILE, LIST FILES, SEARCH FILES, LIST NOTES and VARIABLE REPLACE. Details on these Action Types / Methods are available below.
Field List – this restricts the fields that are to be retrieved from the underlying object.

SmartConnect Function Samples

Visit the interactive demonstration page to test the sample functions.

'Get'

Get Method Sample 1: Retrieve a Single Organization Record

This function will retrieve a single record from the organization using the Company ID. The function is set up to retrieve the fields listed under Field List.

Function Name - 3.01.1 Get Method Sample 1: Retrieve a Single Organization Record
Object Type - Company
Action Type - Get
Field List - sf_Company ID;;sf_Name;;sf_Address;;sf_City;;sf_Country;;sf_Zip / Postal Code;;cf_EIN Number;;sf_Mission Statement

Get Method Sample 2: Retrieve a Single Contact Record

This function will retrieve a single record from the users table using the User ID. The function is set up to retrieve the fields listed under Field List.

Function Name - 3.01.2 Get Method Sample 2: Retrieve a Single Contact Record
Object Type - User
Action Type - Get
Field List - sf_User ID;;sf_Last Name;;sf_First Name;;sf_Prefix;;sf_Suffix;;sf_Title;;sf_Phone;;sf_Email

Get Method Sample 3: Retrieve a Single Grant Application Record

This function will retrieve a single record from the Universal Tracking Application Level 1 using the Opportunity ID.

Function Name - 3.01.3 Get Method Sample 3: Retrieve a Single Grant Application Record
Object Type - Submission Manager - Grant
Action Type - Get
Field List - cf_Project Name;;cf_Submission Number;;sf_Application Type;;sf_Status;;sf_Customer;;sf_Owner;;cf_Focus Area;;cf_Amount Requested;;cf_Program Area;;cf_Location;;cf_Proposed Start Date;;cf_Proposed End Date

Get Method Sample 4: Retrieve a Single Grant Application Payment Record

This function will retrieve a single record from the Universal Tracking Application Level 2 using the Event ID.

Function Name - 3.01.4 Get Method Sample 4: Retrieve a Single Grant Application Payment Record
Object Type - Submission Manager - Activity
Action Type - Get
Field List - sf_Status;;sf_Activity Type;;cf_Payment ID;;cf_Payment Amount;;cf_Payment Date;;Payment Notes

'List'

02.1 List Method Sample 1: Retrieve a list of contacts

Function will retrieve a list of contacts based on criteria specified.

Function Name - 3.02.1 List Method Sample 1: Retrieve a list of Contacts
Object Type - User
Action Type - List
Field List - sf_User ID;;sf_First Name;;sf_Address;;sf_Address 2;;sf_City;;sf_Country;;sf_State / Province;;sf_Zip / Postal Code;;

Sample 1A: To retrieve a list of contacts where the first name begins with "J" and sorted by first name in ascending order
--Begin custom parameter --
criteria : [{"andor":"or","field":"sf_First Name","operator":"like","value":"J%"}]
sortby : [{"field":"sf_First Name","direction":"asc"}]
getstorevalue :
--End custom parameter--

Sample 1B: To retrieve a list of contacts where the first name begins with "S" and the address contains "Peter" and sorted by first name in ascending order
--Begin custom parameter --
criteria : [{"andor":"or","field":"sf_First Name","operator":"like","value":"S%"},
{"andor":"and","field":"sf_Address","operator":"like","value":"%Peter%"}]
sortby : [{"field":"sf_First Name","direction":"asc"}]
getstorevalue :
--End custom parameter--