(2024.1) Syntax
- Brian Dixon
- Joel Duncan
- 1 PCR-360 Data functions
- 1.1 query
- 1.1.1 Parameters
- 1.1.2 Return Values
- 1.2 listGetByCode
- 1.2.1 Parameters
- 1.2.2 Return Values
- 1.3 listFindValue
- 1.3.1 Parameters
- 1.3.2 Return Values
- 1.4 listFindCode
- 1.4.1 Parameters
- 1.4.2 Return Values
- 1.5 call
- 1.5.1 Parameters
- 1.5.2 Return Values
- 1.5.3 Example
- 1.5.4 Example
- 1.6 debug
- 1.6.1 Example
- 1.6.2 Example debug use
- 1.1 query
Each of the different types of Custom Logic: Custom Events, Custom API, and Custom Validation share these common syntaxes and available functions.
PCR-360 Data functions
query
Execute read-only SQL query on database.
array $this->query ( string $sql, array $bind_parameters );Parameters
$sql The query string. All data inside the query should be bound with named bind variables or properly escaped.
$bind_parameters An array of key value pairs with elements that are bound parameters in the SQL statement being executed. Array key names match the named bind variables in the SQL statement.
Return Values
Returns FALSE on failure. For successful queries, query() will return an array of data.
listGetByCode
Lookup the RECID(s) for the List determined by the type and the code(s).
mixed $this->listGetByCode ( string $list_type, mixed $list_code );Parameters
$list_type The List Type specification of the desired record.
$list_code A string or array specifying the one or more List Codes belonging to the specified List Type. Only RECIDs for valid Codes will be returned. An array of three codes where one is invalid will return an array of two valid RECIDs.
Return Values
Returns a List RECID or array of List RECIDs if records were found. Returns NULL if nothing is found.
listFindValue
Lookup the List value for given List RECID.
string $this->listGetByCode ( int $recid );Parameters
$recid The List Recid to find in the LISTS table.
Return Values
List Value of the specified record. Returns NULL if nothing is found.
listFindCode
Lookup the List code for given List RECID.
Parameters
$recid The List Recid to find in the LISTS table.
Return Values
List Code of the specified record. Returns NULL if nothing is found.
call
The Custom API and Custom Events can invoke the Write methods for API types by using the call function. This function allows passing data from the Custom API or Events to the API logic. When invoking this from the Custom API this feature allows you to reformat the incoming API data - perform data validation and lookup and then handoff the properly formatted data to write data. When invoked from a Custom Event it allows scheduled or triggers events to update this data.
Parameters
$method The callable method name. The available callable methods: saveCable, saveContact, saveEquipment, saveGla, saveService, and saveServiceDesk
$params An array of key payload data that is passed to the other API calling function.
Return Values
The function returns a result array containing 'data' which specifies the outcome of the call. For a successful call to saveServiceDesk, this array contain the Service Desk item/action that was created.
Example
In this example, the $payload array contains all the parameters required to create a Service Order and Action
Example
In this example, the Contact API is being invoked via the Custom API endpoint
debug
The debug command outputs to a cache which is then displayed in the Debug tab/grid for the (2024.1) Custom Logic you are debugging.
Example
In this example, the debug function is being invoked.