What code sections can linkToScript or getFromScript be called from?
These are action code functions, but getFromScript refers to exceptions that can be executed in the code.
What happens if the third-party server does not respond when called?
The process timeout in Totum does not affect this; it will indefinitely wait for the external server until it returns an error code.
To avoid hard freezes, set the timeout parameter.
Can getFromScript be done by cron?
Of course!
Can I see an error if the action code is executed by a cron and the third-party server did not respond?
Yes, for this you need to wrap the cron code in tryCatch and in the catch section write the action that needs to be taken if the cron code ends with an error — for example, send a notification to the admin:
=send_admin: set(table: 'table'; field: 'h_data' = $script)
// Request without parameters
script: getFromScript(uri: "https://example.host/api/uri/"; timeout: 30)
send_admin: insert(table: 'notifications'; field: 'code' = "admin_text"; field: 'active_dt_from' = $#ndt; field: 'title' = "Cron Error"; field: 'user_id' = 1; field: 'vars' = json`["text":$#error]`; field: 'active' = true)
In this example, the tryCatch syntax call is used — the error text in this case can be obtained from the $#error variable.
This example is for understanding how to handle cron errors if you need different behavior. Currently, Totum already implements automatic email sending to the email specified in Conf.php and notifications to the admin user in case of a cron error.
If a third-party server call is invoked several times during code execution, how can I cache it as part of code execution?
The standard string delimiter tilde — ~ is used.
An example of SMS sending
Quite often, directly calling an external server during the execution of certain actions within Totum is considered bad practice, as the response delay from the external server will slow down the action in the system.
In this case, an asynchronous sending mechanism is implemented. For example, if we need to send an SMS to a client based on certain conditions, then:
Create a table for SMS.
Each row in this table will be a separate SMS.
When an action is performed, we record a row in this table with the text and the recipient's phone number.
Place the code for calling the external server in a checkbox for modification.
Set cron jobs to check every 1-5 minutes.
This way, if the SMS API server or Telegram bot goes down, actions within Totum will continue to occur without delays.