Page Comparison

...

getPrevious, getCode, getLine

Debug

error_log, debug

Debug Function

$this->debug();

Note: The debug command outputs to a cache which is then displayed in the Debug tab/grid for the Custom Logic you are debugging.

Logical

as, if, break, case, catch, continue, default, do, else, elseif, finally, for, foreach, function, match, new, return, switch, try, while

...

abs, base_convert, bindec, ceil, exp, floor, hexdec, max, min, octdec, pow, rand, round, srand, trunc

PCR-360 Data

call, listFindCode, listFindValue, listGetByCode, query

...

call Function: Calling API Logic

/*
$apiFunction Options: 
  saveService, saveServiceDesk, saveContact, saveCable, saveGla, saveEquipment, saveLocation,
  renderCustomReport, renderCableViewPath
*/

array $this->call (string $apiFunctionToCall, array $params, bool $commitOnSuccess);

...

query Function: Querying Data

array $this->query ( string $sql, array $bind_parameters );

// Example:
$results = $this->query("SELECT * FROM SERVICES WHERE RECID = :recid", [':recid' => 123]);

listGetByCode Function: Retrieving List Values

mixed $this->listGetByCode ( string $list_type, mixed $list_code );

listFindValue Function: Retrieving List Values

string $this->listGetByCode >listFindValue( int $recid );

listFindCode Function: Retrieving List Values

string $this->listGetByCode >listFindCode( int $recid );string $this->listGetByCode ( int $recid );

PCR-360 Debug

debug, error_log

debug Function: Debugging Custom Logic

$this->debug(mixed $debug);

PCR-360 Events

attach, attachDb, callCustomEvent, detach, detachDb, trigger

PCR-360 Reports

addError, assign, barcode, loadReport

PCR-360 Utility

arrayToCsv, createFile, sendSystemMessage

arrayToCsv Function: Building CSV Data

string $this->arrayToCsv(array $data, string $delimiter = ',', string $enclosure = '"'): array 

$data: An array of values to convert to CSV

$delimiter: The character that is used to separate the values

$enclosure: Character used to encapsulate the data when the data contains the delimiter

/*
Generate a CSV in the OUTBOUND directory 
named 'MY-OUTBOUND-FILE.csv' with the following content:

      a, b, c, 1, 2, 3
      d, e, f, 4, 5, 6
*/

$array = [
  ['a', 'b', 'c', 1, 2, 3],
  ['d', 'e', 'f', 4, 5, 6]
];
$csv = $this->arrayToCsv($array);

createFile Function

Users can use Custom Logic to create files directly onto the Inbound/Outbound directories for processing either by internal processes (Inbound) or external processes (Outbound).

createFile(string $filename, string|array $content, string $location = 'OUTBOUND', bool $overwrite = false) : int|false

$filename: The name of the file to create. Any path will be ignored; just the basename used

$content: The data to write to the file. String will be written as is, arrays will be written as if implode('', $content)

$location: The location in which to create the file. Supported values are INBOUND and OUTBOUND; any other value should cause the function to return false after logging an error

• If the location is not supported, it will log an error and return false

• If the overwrite is false and the file exists, it will log an error and return a false

• If the location does not exist, it will be created

• If an error occurs while writing the file, the error will be logged, and false will be returned

• When the file is successfully written, the number of bytes written will be returned

// Example
$bytesWritten = $this->createFile('MY-OUTBOUND-FILE.csv', $csv , 'OUTBOUND', true);

if ($bytesWritten === false) {
  // There was an error creating the file, handle that here
  // Check the error log for more details
} else {
  // The file was created successfully $bytesWritten will be the number of bytes written
}

createFile Function: Creating Inbound/Outbound Files

int|false $this->createFile(string $filename, string|array $content, string $location = 'OUTBOUND', bool $overwrite = false);

sendSystemMessage Function: Sending a System Message

bool $this->sendSystemMessage(string $subject, string $body, int $contactRecid, string $identifier);

PCR-360 Validation

setError, setMessage, setWarning

setError Function: Errors and Warning in Validation

Sets a validation error message. This messages output in the UI if the validation logic returns false. If this function is called multiple times, only the message from the last calls is displayed.

$this->setError(string $message);

setWarning Function: Errors and Warning in Validation

Sets the validation warning message. This messages output in the UI only if the logic does not return false. If this function is called multiple times, only the message from the last calls is displayed.

$this->setWarning(string $message);

Regular Expressions (Perl-Compatible)

...

Contact PCR if you find a function that is not allowed, but would like to use. 

PCR-360 Validation

setError, setMessage, setWarning

setError Function

Sets a validation error message. This messages output in the UI if the validation logic returns false. If this function is called multiple times, only the message from the last calls is displayed.

$this->setError ( string $message );

setWarning Function

Sets the validation warning message. This messages output in the UI only if the logic does not return false. If this function is called multiple times, only the message from the last calls is displayed.

$this->setWarning ( string $message );

Triggering Events

PCR_Event, trigger, attach, attachDb, detach, detachDb

In this example the GLA Replace Event is triggered with specific parameters. For detailed information on which Events can be triggered, and how to trigger those Events, please navigate to the Triggerable Events List page.

PCR_Event Functions

PCR_Event::attachDb("replace-gla", [
    "Application_Model_Gla_Gla" => "eventReplaceGla"
]);
PCR_Event::trigger("replace-gla", [
	"contact" => 12345,        // Contact RECID
    "users_recid" => 456,      // Users RECID
    "glaRecid" => [1111],      // Old GLA RECID
    "replaceGlaRecid" => 2222, // Replacement GLA RECID
    "setInactiveGla" => true,
    "comment" => "This is a comment",
]);
PCR_Event::detachDb("replace-gla");

...

The following function in the Custom Logic tab allows the User to call a Custom Event. This enables flexibility in having a single custom process gather data for different pieces of Custom Logic.

mixed $this->callCustomEvent (string $eventIdentifier, array $data); 

// Example:
$callEventResult = $this->callCustomEvent('Event Identifier', $data ?? []);
if ($callEventResult > 10) {
  // Do something for 10 or more
} else {
  // Do something for 9 or less
}

Sending a System Message

A system message can be sent from Custom Logic using the following format:

...

...