Difference between revisions of "Creating SmartConnect Functions"

Revision as of 10:06, 30 August 2018

Please note that this page is currently under construction. There is more information to come.

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.

1. Log into the copy of SmartSimple where you wish to add the function.
2. Navigate to Global Settings.
3. Click on the Integrations tab.
4. Click on the SmartConnect API link. Existing functions will be listed here for you to update.
5. 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

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

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

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

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

Report

Report Query

Function Name  -  3.02.1 Get Report Sample 1: Report Query
Object Type  -  Report
Action Type   -  Query
Field List  - none

A report query on the number of assessors grouped by specialty

A sample that will display the number of Assessors based on their specialty
--Begin custom parameter --
reportid : 36864
criteriavalue: none
--End custom parameter--

A report query on a list of Grants grouped by Organization

A sample that shows a list of applications filtered by "Approved Proposal" status grouped by organizations
--Begin custom parameter --
reportid : 36812
criteriavalue: none
--End custom parameter--

A report query on a list of Grants grouped by Focus Area

A sample that displays a list of applications grouped by focus area
--Begin custom parameter --
reportid : 36814
criteriavalue: none
--End custom parameter--

A report query on a list of Payments grouped by Grant Type

A sample that  displays the payment amount for each grant grouped by organization
--Begin custom parameter --
reportid : 36806
criteriavalue: none
--End custom parameter--

List

List

Retrieve a list of contacts

This function will retrieve a list of contacts based on criteria specified.

Function Name  -  3.03.1.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--

Retrieve a list of organizations

Function Name  -  3.03.1.2 List Method Sample 2: Retrieve a list of Organizations
Object Type  -  Company
Action Type   -  List
Field List  -  sf_Company ID;;sf_Name;;sf_Address;;sf_Address 2;;sf_City;;sf_Country;;sf_State / Province;;sf_Zip / Postal Code;;cf_Mission Statement

Sample 2A
To retrieve a list of organizations with organization name that starts with "Br"
 --Begin custom parameter --
 criteria : [{"andor":"and","field":"sf_Name","operator":"like","value":"Br%"}]
 sortby : 
 getstorevalue :
 --End custom parameter--

Sample 2B
To retrieve a list of organizations with organization name that starts with "Br" and address that contains "Ave" with an ascending order based on the organization name.
 --Begin custom parameter --
 criteria : [{"andor":"and","field":"sf_Name","operator":"like","value":"Br%"},{"andor":"and","field":"sf_Address","operator":"like","value":"%Ave%"}]
 sortby : [{"field":"sf_Name","direction":"asc"}]
 getstorevalue :
 --End custom parameter--

Retrieve a list of claims

Function Name  -  3.03.1.3 List Method Sample 3: CMS360° - Retrieve a list of claims
Object Type  -  Cast Management 360° - Case
Action Type   -  List
Field List  -  sf_Application Template Type;;sf_Customer;;cf_Claim;;cf_Nature of Injury / Comments on Claim;;sf_Activity List

To retrieve a list of claims from professors in profession sorted by organization name in descending order.  

--Begin custom parameter --
 criteria : [{"andor":"and","field":"cf_Nature of Injury / Comments on Claim","operator":"like","value":"%professor%"}]
 sortby : [{"field":"sf_Customer","direction":"desc"}]
 getstorevalue :
 --End custom parameter--

List File

List files from an organization

List files from an application

List Notes

List notes from an application

List Multiple Addresses

List Multiple Addresses of an Organization

List Associations

List Contact associations from an application

List Organization associations from an application

'Metadata'

Get Metadata from CMS360° Application Metadata

Get Metadata from GMS360° Application Metadata

Update

Update

Create/Update organization record

Create/Update User record

Update Multiple Addresses

Update/create multiple address record of an Organization

Update Associations

Create/Update contact associations of a Level 1

'Download File'

Download File(s) from a company profile

'Search File'

06.1 Search Files Method Sample 1: Search Case Documents

See Also

SmartConnect - RESTful API
JSON API (SmartConnect) Standard Field Names

API Sample Code