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 - Locate a Contact/User|contact_find(flag,callbackfunc,fields,filter,order,start,end,prefix)]] ||search function to retrieve contacts.|-|[[Pandora - Find a Level 1 Contact|levelonecontact_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,appid,fields,filter,order,start,end,prefix)]]|| UTA invoice search.|-|[[Pandora - Locate a UTA Invoice Item|invoiceitem_find(flag,callbackfunc,appid,invoiceid, fields,filter,order,start,end,prefix)]]|| Enables access to UTA invoice items.|-|[[Pandora - Return a Record Set of Level 1 Skills|leveloneskills_find(flag,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 - Returns All Webforms Recordset|webform_list(flag/callbackfunc,actionname,formid,scoreid,filter,order)]]|| Enables return of all webforms recordset.|-|[[Pandora - Create an Organisation Recordset (HTML)|company_list(flag,callbackfunc,fields,filter,html,order,start,end,cfidused)]]|| Enables return of an organisation recordset.|-|[[Pandora - Create UTA Level 1 Recordset (HTML)|levelone_list(flag,callbackfunc,appid,fields,filter,html,order,start,end,cfidused)]]||Enables return of UTA Level 1 recordset.|-|[[Pandora - Create UTA Level 2 or 3 Recordset (HTML)|level23_list(flag,callbackfunc,appid,level,fields,filter,html,order,start,end,cfidused)]] ||Enables return of UTA Level 2 or 3 Recordset|} ==='''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 - Update Contact (One Record)|contact_update(flag,callbackfunc,rset,loginfornew)]]||Enables update of single contact or creation of new user.
|-
|[[Pandora - Retrieve Current User’s Organisational InformationUpdate User Setting|Session_getCurrentCompany usersetting_update(Findflag,callbackfunc,userid,key,value)]] || Enables retrieving the current user’s organisational informationupdate of user system settings.|-|[[Pandora - Update Organisations (One Record)|company_update(flag,callbackfunc,rset)]]|| Enables update of single organisation or creation of new organisation.|-|[[Pandora - Update Category|category_update(flag,callbackfunc,recordset)]]||Enables update of a category list of a company or creation of a new category list.|-|[[Pandora - 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_update(flag,callbackfunc,appid,rset)]]|| Enables update of single invoice line items or creation of new invoice line items.|-|[[Pandora - Update UTA Invoice Entity|invoice_update(flag,callbackfunc,appid,rset)]]||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,parenttype,parentobject,childtype,childoject,roleid)]]|| Enables ability to associate an organisation or contact with a UTA level 1, 2 or 3 record.|-|[[Pandora - Remove a UTA Role (Company or Contact) and Associate 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.|-|[[Pandora - 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(flag,callbackfunc,msgtype,format,fromadd,touserid,cc,subject,body)]] ||Enables sending a message (email or quick message).
|}
==='''Utility Functions'''===
The following functions are used for specific purposes.
{| border="1" cellpadding="5"
!Function
!Description
|-
|[[Pandora - Locate an OrganisationFormat Date Function|company_findformat_date(flag,callbackfunc,fields,filter,order,start,end,prefixd)]] ||Enables organisation search functions to retrieve all organisationsdate formatting.
|-
|[[Pandora - Locate a Contact/UserVariables Replace|contact_findvariables_replace(flag,callbackfunc,fieldsobjecttype,filterobjectid,ordercontent)]]|| Invokes the variable processor and returns formatted content.|-|[[Pandora - Trigger a Workflow|trigger_workflow(objectid,startwfid,endobjecttype)]]|| Triggers a workflow.|-|[[Pandora - Loading Variables|variables_replace(flag,callbackfunction,40,userid,prefixvariable)]] ||Enables contact search functions can retrieve all contactsObtains [[System Variables]] or other values.
|}
==='''UTA Specific Transaction Functions'''==={| border="1" cellpadding="5"
!Function
!Description
|-
|[[Pandora - Locate a UTA Level 1 EntityUpdate or Create Transaction|levelone_findtrans_update(flag,callbackfunc,appidrset,fieldslinkobjectid,filter,order,start,end,prefixlinktype)]] ||Enables access to Level 1 itemsUpdates or creates transaction record.
|-
|[[Pandora - Locate a UTA Level 2 EntityDelete Transaction|level23_findtrans_delete(flag,callbackfunc,appid,level,fields,filter,order,start,end,prefixtransid)]]||Enables access to Level 2 itemsDeletes a transaction record.
|-
|[[Pandora - Locate a UTA Level 3 EntityFind Transaction|level23_findtrans_find(flag,callbackfunccallback,appidtrstatusid,leveltrltranslinkid,trlobjectid,fields,filter,order,start,end,prefix)]]|| Enables access to Level 3 items I UTAsFinds a transaction record.
|-
|[[Pandora - Locate a UTA Invoice EntityUpdate or Create Transaction Intersection to Level 1 or Level 2|invoiceitem_findtranslink_add(flag,callbackfunc,appid,invoiceid,fieldstranslinkid,filtertransid,orderobjectid,startlinktype,end,prefixrecordset)]] ||Enables access to UTA invoices (invoice item Updates intersection table between Transactions and invoice line item)Level 1 or Level 2 records.
|-
|[[Pandora - Locate a UTA Remove Transaction Intersection to Level 1 Skillor Level 2|leveloneskills_updatetranslink_remove(flag,callbackfunc,translinkid,transid,objectid,rslinktype)]] ||Enables access to Removes the intersection between Transactions and Level 1 skillsor Level 2 records.
|}
The following guides are common to all function calls.
[[Category:Pandora]]