Controlling Logs and Notifications
JustOn Billing & Invoice Management can log business-related information and errors. Generally, it writes the logged data to files attached to invoice run, dunning run or subscription records. In addition, the software allows for sending information about batch chain execution via email.
Operations like deletions or status modifications (Draft
→ Open
or Open
→ Paid
), or any events that produce errors, for example, are tracked and will appear in the logged data as individual records. Consequently, the logging feature enables history tracking and supports auditing procedures.
Logging Concepts
Log files are stored as attachments to invoice run, dunning run or subscription records. If the Attachments related is not visible, you may need to add it to the page layout of the corresponding object. For details, see Managing Pages.
Log file names consist of the creation timestamp and the extension .log
. At the size of approx. 2 MB, the log file is closed, and JustOn starts writing to a new file. The log lines are ordered by timestamp in ascending order, that is, new events are written to the end of the file.
JustOn uses the following log pattern:
timestamp | user ID | business logic class | severity | message
That is, a log file record could look, for example, as follows:
2017-05-29 16:17:30 +0200 | 0050Y000000GJvrQAG | BatchInvoiceRun | INFO | Number of records per execute: ["1","1"]
Depending on your requirements, you can define various levels of detail – according to the event's severity – for the logged information:
Level | Description |
---|---|
NONE |
No events are logged. |
FATAL |
Exceptions flagged as FATAL (conditions that prevent an operation from being executed) are logged. |
ERROR |
Events flagged as ERROR (conditions that have produced errors on execution) are logged. |
WARNING |
Events flagged as WARNING (conditions that potentially may produce issues) are logged. |
INFO |
Events flagged as INFO (execution statuses, etc.) are logged. |
INFO
is the "finest" setting and generates the most log output. Each level includes the levels above, that is, the level ERROR
, for example, logs events of the severity ERROR
and FATAL
.
Enabling Logging
Logging is not enabled by default. To enable it, modify the corresponding global setting.
-
Click to enter Setup, then open Custom Settings.
In Salesforce Lightning, navigate to Custom Code > Custom Settings.
In Salesforce Classic, navigate to Develop > Custom Settings.
-
Click Manage in the row of Global Settings.
- Click Edit in the row of Default.
-
In the field
Log Level
, specify the intended level of detail.Possible values include (in this order):
NONE
,FATAL
,ERROR
,WARNING
,INFO
. -
Click Save.
This activates the logging with the defined level. If the
Log Level
field is empty or set toNONE
, JustOn does not generate log files.
Batch Chain Notification Concepts
JustOn allows for sending information about batch chain execution via email.
Info
JustOn notifies the user who has triggered the batch chain.
You can define the same levels of detail for the recorded information as available for logging:
Level | Description |
---|---|
NONE |
No events are logged. |
FATAL |
Exceptions flagged as FATAL (conditions that prevent an operation from being executed) are logged. |
ERROR |
Events flagged as ERROR (conditions that have produced errors on execution) are logged. |
WARNING |
Events flagged as WARNING (conditions that potentially may produce issues) are logged. |
INFO |
Events flagged as INFO (execution statuses, etc.) are logged. |
Be aware that JustOn creates and sends a notification if a log record of the corresponding severity level has been produced during the batch chain execution. You can, consequently, have JustOn generate log output of the level INFO
but send notifications of the level ERROR
only.
The produced notification email includes links to all object records for which JustOn has produced log output. That is, if there has been an error with an invoice run, you receive a deep link to the corresponding invoice run record.
Example batch chain notification email
Enabling Batch Chain Notifications
Batch chain notifications are not enabled by default. To enable the feature, modify the corresponding global settings.
Note
Batch chain notifications require logging to be enabled.
-
Click to enter Setup, then open Custom Settings.
In Salesforce Lightning, navigate to Custom Code > Custom Settings.
In Salesforce Classic, navigate to Develop > Custom Settings.
-
Click Manage in the row of Global Settings.
- Click Edit in the row of Default.
-
In the field
Notification Level
, specify the intended level of detail.Possible values include (in this order):
NONE
,FATAL
,ERROR
,WARNING
,INFO
. -
In the field
Notification Target
, setEMAIL
. -
Click Save.
This activates the batch chain notification via email with the defined level. If the
Notification Target
field is empty, JustOn does not send batch chain notifications.