0
edits
Changes
no edit summary
* Utility functions – these functions provide additional general functionality to the API.
==='''General System Session Level Functions'''===
These functions are general used to the entire instanceenable a valid session in which process can be performed and once created, determine user and related organisation attributes.Unless a function is established, no functionality is available. {| border="1" cellpadding="5"
!Function
!Description
|[[Pandora - Log in a User|Session_Login (Find)]] ||Enables Login to the instance.
|-
|[[Pandora - Logout a User|session_logout(flag,callbackfunc)]]||Enables logout of the instance.|-|[[Pandora - Verify If a Session Exists|session_islogin(flag,callbackfunc)]] || Retrieve active user information.|-|[[Pandora - Current User’s Information|Session_getCurrentUser (Find)]] ||Enables retrieving Retrieve the current user information.|-|[[Pandora - Retrieve Current User’s Organisational Information|Session_getCurrentCompany (Find)]] || Retrieve the current user’s organisational information.|} ==='''Information Finding Functions'''=== These functions return record sets containing multiple records based on the filter passed to the functions.Each of these functions uses the following parameters: *Fields – the fields list to be retrieved and created in the recordset. Notes an ID field will be prefixed onto the user specified field list providing the unique identifier for each record.*Filter – the criteria by which fields should be retrieved.*Order – the field list to control the sort sequence of the records set.*Start – the starting record to be returned. The default is 0.*End – the end record to be returned. The default is 200.*Pref - {| border="1" cellpadding="5" !Function!Description|-|[[Pandora - Locate an Organisation|company_find(flag,callbackfunc,fields,filter,order,start,end,prefix)]] ||Search function to retrieve organisations.
|-
|[[Pandora - Retrieve Current User’s Organisational InformationLocate a Contact/User|Session_getCurrentCompany contact_find(Findflag,callbackfunc,fields,filter,order,start,end,prefix)]] || Enables retrieving the current user’s organisational informationsearch function to retrieve contacts.
|-
|[[Pandora - Send Find a MessageLevel 1 Contact|send_msglevelonecontact_find(flag,callback,appid,opportunityid,fields,filter,order,start,end,prefix)]]|| Level 1 contact search.|-|[[Pandora - Find a Level 1 Company|levelonecompany_find(flag,callback,appid,opportunityid,fields,filter,order,start,end,prefix)]]|| Level 1 company search.|-|[[Pandora - Find a Level 2 or 3 Contact|level23contact_find(flag,callbackfunc,appid,level,eventid,fields,filter,order,start,end,prefix,groupby)]]|| Level 2/3 contact search.|-|[[Pandora - Find a Level 2 or 3 Company|level23company_find(flag,callbackfunc,appid,level,eventid,fields,filter,order,start,end,prefix,groupby)]]|| Level 2/3 company search.|-|[[Pandora - Locate a UTA Level 1 Entity|levelone_find(flag,callbackfunc,appid,fields,filter,order,start,end,prefix,specialfind,groupby)]] || Level 1 item search.|-|[[Pandora - Locate a UTA Level 2 Entity|level23_find(flag,callbackfunc,appid,level,fields,filter,order,start,end,prefix)]]||Level 2 item search.|-|[[Pandora - Locate a UTA Level 3 Entity|level23_find(flag,callbackfunc,appid,level,fields,filter,order,start,end,prefix)]]|| Level 3 item search.|-|[[Pandora - Locate a UTA Invoice Entity|invoice_find(flag,callbackfunc,msgtypeappid,formatfields,fromaddfilter,touseridorder,ccstart,subjectend,bodyprefix)]]|| UTA invoice search.|-|[[Pandora - Locate a UTA Invoice Item|invoiceitem_find(flag,callbackfunc,appid,invoiceid, fields,filter,order,start,end,prefix)]] ||Enables sending access to UTA invoice items.|-|[[Pandora - Return a message Record Set of Level 1 Skills|leveloneskills_find(email or quick messageflag,callbackfunc,objectid)]]|| Enables return of a record set of skills for Level 1 items.|-|[[Pandora - Return a Skill List from a Skill Category|skills_find(flag,callbackfunc,skilltypeid)]]|| Enables return of a record set of skill categories for Level 1 items.|} ==='''Recordset Retrieval Functions'''=== {| border="1" cellpadding="5" !Function!Description|-|[[Pandora - Create a Contact Recordset (HTML)|contact_list(flag,callbackfunc,fields,filter,html,order,start,end,cfidused)]]|| Enables creation of a contact recordset.
|-
|[[Pandora - Locate an OrganisationReturns All Webforms Recordset|company_findwebform_list(flag/callbackfunc,callbackfuncactionname,formid,fieldsscoreid,filter,order,start,end,prefix)]] ||Enables organisation search functions to retrieve return of all organisationswebforms recordset.
|-
|Company Below [[Pandora - Create an Organisation Recordset (FindHTML)|company_list(flag,callbackfunc,fields,filter,html,order,start,end,Updatecfidused) ]]|| Enables return of an organisation search functions to retrieve only organisations at the user’s hierarchical level and lowerrecordset.
|-
|[[Pandora - Locate a Contact/UserCreate UTA Level 1 Recordset (HTML)|contact_findlevelone_list(flag,callbackfunc,appid,fields,filter,html,order,start,end,prefixcfidused)]] ||Enables contact search functions can retrieve all contactsreturn of UTA Level 1 recordset.
|-
|Contact Below [[Pandora - Create UTA Level 2 or 3 Recordset (FindHTML)|level23_list(flag,callbackfunc,appid,level,fields,filter,html,Updateorder,start,end,cfidused) ]] ||Enables contact search functions to retrieve contacts at the user’s hierarchical level and lowerreturn of UTA Level 2 or 3 Recordset
|}
==='''UTA Specific Information Update Functions'''=== The following functions are used to update an existing record or create a new record. These functions only work with a single record. {| border="1" cellpadding="5"
!Function
!Description
|-
|[[Pandora - Locate a UTA Level 1 EntityUpdate Contact (One Record)|levelone_findcontact_update(flag,callbackfunc,appidrset,fieldsloginfornew)]]||Enables update of single contact or creation of new user.|-|[[Pandora - Update User Setting|usersetting_update(flag,filter,ordercallbackfunc,startuserid,endkey,prefixvalue)]] ||Enables access to Level 1 itemsupdate of user system settings.
|-
|[[Pandora - Locate a UTA Level 2 EntityUpdate Organisations (One Record)|level23_findcompany_update(flag,callbackfunc,appid,level,fields,filter,order,start,end,prefixrset)]]||Enables access to Level 2 itemsupdate of single organisation or creation of new organisation.
|-
|[[Pandora - Locate a UTA Level 3 EntityUpdate Category|level23_findcategory_update(flag,callbackfunc,appid,level,fields,filter,order,start,end,prefixrecordset)]]|| Enables access to Level 3 items I UTAsupdate of a category list of a company or creation of a new category list.
|-
|[[Pandora - Locate Update UTA Level 1 Entity (One Record)|levelone_update(flag,callbackfunc,appid,rset)]]||Enables update of single UTA level one entity or creation of new UTA level one entity.|-|[[Pandora - Update UTA Level 2 or 3 Entity (One Record)|level23_update(flag,callbackfunc,appid,level,rset)]]|| Enables update of single UTA level 2 or 3 entity or creation of new UTA level 2 or 3 entity.|-|[[Pandora - Update Parent of UTA Level 2 or 3 Entity|level23_parentupdate(flag,callbackfunc,appid,level,eventid,parentid)]]|| Enables update of parent id of UTA level 2 or 3 entities.|-|[[Pandora - Delete UTA Level 2 or 3 Entity (One Record)|level23_delete(flag,callbackfunc,appid,level,eventid)]]|| Deletes a single UTA level 2 or 3 entity|-|[[Pandora - Update UTA Invoice Items Entity|invoiceitem_findinvoiceitem_update(flag,callbackfunc,appid,invoiceidrset)]]|| Enables update of single invoice line items or creation of new invoice line items.|-|[[Pandora - Update UTA Invoice Entity|invoice_update(flag,callbackfunc,appid,fieldsrset)]]||Enables update of single invoice record or creation of new invoice record.|-|[[Pandora - Add a UTA Role (Company or Contact) and Associate Feature|utarole_add(flag,callbackfunc,filterparenttype,orderparentobject,startchildtype,endchildoject,prefixroleid)]] ||Enables access ability to associate an organisation or contact with a UTA level 1, 2 or 3 record.|-|[[Pandora - Remove a UTA invoices Role (invoice item Company or Contact) and invoice line itemAssociate Feature|utarole_remove(flag,callbackfunc,parenttype,parentobject,childtype,childoject,roleid)]]||Enables ability to remove an organisation or contact with a UTA level 1, 2 or 3 record.|-|[[Pandora - Update UTA Role Custom Fields (Company or Contact) and Associate Feature|utarole_update(flag,callbackfunc,parenttype,objectid,objecttype,rset)]]||Update role/category based custom fields for an organisation or contact attached to a UTA record or for company/contact associations
|-
|[[Pandora - Locate a UTA Level 1 Skill|leveloneskills_update(flag,callbackfunc,objectid,rs)]] ||Enables access to Level 1 skills.
|-
|UTA [[Pandora - Use Level One Item Security Matrix Update a System Variable|sysvar_update(flag,callbackfunction,varname,value)]] ||Update or create a system variable|} ==='''Messaging Functions'''=== The following function is used to trigger a message. {| border="1" cellpadding="5" !Function!Description|-|[[Pandora - Send a Message|send_msg(Allflag,callbackfunc,msgtype,format,fromadd,touserid,cc,subject,body) ]] ||Enables sending a message (email or quick message).|Enforces UTA security } ==='''Utility Functions'''=== The following functions are used for Level specific purposes. {| border="1 items" cellpadding="5" !Function!Description|-|[[Pandora - Format Date Function|format_date(d)]]|| Enables date formatting.
|-
|UTA [[Pandora - Use Level Two Item Security Matrix Variables Replace|variables_replace(Allflag,callbackfunc,objecttype,objectid,content) ]]||Enforces UTA security for Level 2 itemsInvokes the variable processor and returns formatted content.
|-
|UTA [[Pandora - Use Trigger a Workflow|trigger_workflow(objectid,wfid,objecttype)]]|| Triggers a workflow.|-|[[Pandora - Loading Variables|variables_replace(flag,callbackfunction,40,userid,variable)]]||Obtains [[System Variables]] or other values.|} ==='''Transaction Functions'''==={| border="1" cellpadding="5" !Function!Description|-|[[Pandora - Update or Create Transaction|trans_update(flag,callbackfunc,rset,linkobjectid,linktype)]]||Updates or creates transaction record.|-|[[Pandora - Delete Transaction|trans_delete(flag,callbackfunc,transid)]]||Deletes a transaction record.|-|[[Pandora - Find Transaction|trans_find(flag,callback,trstatusid,trltranslinkid,trlobjectid,fields,filter,order,start,end,prefix)]]||Finds a transaction record.|-|[[Pandora - Update or Create Transaction Intersection to Level 1 or Level Three Item Security Matrix 2|translink_add(Allflag,callbackfunc,translinkid,transid,objectid,linktype,recordset) ]]||Enforces UTA security for Updates intersection table between Transactions and Level 1 or Level 2 records.|-|[[Pandora - Remove Transaction Intersection to Level 1 or Level 2|translink_remove(flag,callbackfunc,translinkid,transid,objectid,linktype)]]||Removes the intersection between Transactions and Level 1 or Level 3 items2 records.
|}
The following guides are common to all function calls.
[[Category:Pandora]]