Logs contain a comprehensive list of errors, build data, and your own internal messages. They are useful for troubleshooting problems. As processes occur within Epicor CPQ -- such as output builds, quote workflow actions, and other operations -- information as simple notes are often automatically added to the logs. Log entries can be informational (such as "Output built successfully") or could be informing you of an error (such as "Could not connect to CAD application for output").
Adding your own log messages from Snap rules
To add your own custom log entry, use the 'Write log' Snap block.
For client-side logging, choose "debug". For server-side debugging, choose any of the other 3 options depending on the severity of the message. Message severity starts at "info", increases to "warning" and finally peaks at "error".
Understanding log messages
Where does the logged message appear?
- If the Snap code is client side,
the log entry appears in the user's web browser debugger console. The debugger is usually shown or hidden by pressing the F12 key while using your web browser. Learn more about debugging Snap. - If the Snap code is server side,
the log entry appears in the administrative interface under Infrastructure > Logs with the time of the event and a colorful icon. The icon shows if each message is an error, info, or warning. Search tools are available at the top of the log listing to help you filter the log entries. - If the Snap code is server side and the Notification Settings are active,
then a copy of the log entry is also e-mailed to either individual company admin users, or to all company admins, depending on those notification settings.
*Client-side rules are any rule in a configurator or scene except for build, naming, and pricing rules. Server rules are everything else: build, naming, pricing, workflow, quote, custom action, and safe function.
How long do log messages remain?
- If the Snap code is client side,
The log entries in the console disappear when the web page is refreshed or closed. - If the Snap code is server side,
The log entries under Infrastructure > Logs remain on the server and are visible to any company administrator. From time to time, they are periodically pruned from the environment. Less important logs tagged with "info" are removed after a few weeks. More important logs such as errors stay in the list much longer.
Who can see log messages?
- If the Snap code is client side,
The log entries in the console are only visible to the person using that web browser on that computer. - If the Snap code is server side,
The log entries under Infrastructure > Logs are visible only to users with the role "Company Administrator".
Logs and Jobs are different.
While the Jobs list shows work that is performed asynchronously (there may be some time between when they are requested and when they are completed), the Logs list shows work that is performed synchronously (the work completes immediately). The troubleshooting information you're looking for may be listed in the other location.