Changes

Creating SmartConnect Functions

514 bytes added, 16:04, 30 August 2018

no edit summary

===Get===

====Retrieve a Single Organization Record====

~~This function will retrieve a single record from the organization using the [[Determining_the_companyid|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

'''Description''' - This function will retrieve a single record from the organization using the [[Determining_the_companyid|Company ID]]. The function is set up to retrieve the fields listed under '''Field List'''.

'''Object Type''' - Company

'''Action Type ''' - Get

====Retrieve a Single Grant Application Record====

~~This function will retrieve a single record from the [[Universal Tracking Application]] Level 1 using the [[Determining_the_opportunityid|Opportunity ID]].~~

'''Function Name''' - 3.01.3 Get Method Sample 3: Retrieve a Single Grant Application Record

'''Description''' - This function will retrieve a single record from the [[Universal Tracking Application]] Level 1 using the [[Determining_the_opportunityid|Opportunity ID]].

'''Object Type''' - Submission Manager - Grant

'''Action Type ''' - Get

====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 [[Determining_the_eventid|Event ID]].~~

'''Function Name''' - 3.01.4 Get Method Sample 4: Retrieve a Single Grant Application Payment Record

'''Description''' - This function will retrieve a single record from the [[Universal Tracking Application]] Level 2 using the [[Determining_the_eventid|Event ID]].

'''Object Type''' - Submission Manager - Activity

'''Action Type ''' - Get

====Report Query====

'''Function Name''' - 3.02.1 Get Report Sample 1: Report Query

'''Description''' - To retrieve data from a report.

'''Object Type''' - Report

'''Action Type ''' - Query

=====A report query on the number of assessors grouped by specialty=====

A '''Description''' - A sample that will display the number of Assessors based on their specialty

--Begin custom parameter --

reportid : 36864

=====A report query on a list of Grants grouped by Organization=====

A '''Description''' - A sample that shows a list of applications filtered by "Approved Proposal" status grouped by organizations

--Begin custom parameter --

reportid : 36812

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

A '''Description''' - A sample that displays a list of applications grouped by focus area

--Begin custom parameter --

reportid : 36814

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

A '''Description''' - A sample that displays the payment amount for each grant grouped by organization

--Begin custom parameter --

reportid : 36806

====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

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

'''Object Type''' - User

'''Action Type ''' - List

'''Sample 1A'''

To '''Description''' - 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%"}]

'''Sample 1B'''

To '''Description''' - 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%"}]

=====Retrieve a list of organizations=====

'''Function Name''' - 3.03.1.2 List Method Sample 2: Retrieve a list of Organizations

'''Description''' - To retrieve a list of organizations.

'''Object Type''' - Company

'''Action Type ''' - List

'''Sample 2A'''

To '''Description''' - 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%"}]

'''Sample 2B'''

To '''Description''' - 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%"}]

=====Retrieve a list of claims=====

'''Function Name''' - 3.03.1.3 List Method Sample 3: CMS360° - Retrieve a list of claims

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

'''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 --

=====List files from an organization=====

'''Function Name''' - 3.03.2.1 List Files Method Sample 1: from an organization

'''Description''' - To retrieve the list of file(s) from the organization using the [[Determining_the_companyid|Company ID]]

'''Object Type''' - Company

'''Action Type ''' - List Files

'''Field List''' -

~~To retrieve the list of file(s) from the organization using the [[Determining_the_companyid|Company ID]] where~~Parameters used are:

''objectid'' = [[Determining_the_companyid|Company ID]]

''fieldid;; = [[Custom_Field_ID|Custom Field ID]] of an organization that is either [[Custom_Field_Type:_Upload_-_Single_File_Storage|single file type]] or [[Custom_Field_Type:_Upload_-_Multiple_Files_Storage|multiple file type]].

=====List files from an application=====

'''Function Name''' - 3.03.2.2 List Files Method Sample 2: from an application '''Description''' - To retrieve the list of file(s) of an existing application using the [[Determining_the_opportunityid|Opportunity ID]]

'''Object Type''' - Submission Manager - Grant

'''Action Type ''' - List Files

'''Field List''' -

~~To retrieve the list of file(s) of an existing application using the [[Determining_the_opportunityid|Opportunity ID]] where~~Parameters used are:

''objectid'' = [[Determining_the_opportunityid|Opportunity ID]]

''fieldid;; = [[Custom_Field_ID|Custom Field ID]] of UTA L1 that is either [[Custom_Field_Type:_Upload_-_Single_File_Storage|single file type]] or [[Custom_Field_Type:_Upload_-_Multiple_Files_Storage|multiple file type]].

Lalaine Songalia

Smartstaff

1,385

edits

Changes

Creating SmartConnect Functions

SmartWiki