brixxbox Wiki
Ask or search…
K

logAdd

The brixxbox offers a client-side event log. Events like save/delete record, data validation messages, internal events etc. will be logged. In addition, the log can be accessed through brixxApi. The log view is located in the side bar. It will be shown in an extra tab page (only if data is available). Per default only entries for the current brixxApi Object (and its children) will be visible.

Parameters

Parameters can be passed as a json object.
  1. 1.
    text: the actual log text. If this value is missing no entry will be generated.
  2. 2.
    context: This should be set to a plausible group-criteria (e.g. “save” for record saved. “validate” for data validation). This value can also be used to remove the complete group from the log (see example).
  3. 3.
    status: Status can have the following values “info”, “success”, “warning”, “danger” or “error”. The log entry will get its color set accordingly. “danger” and “error” are interchangeable.
  4. 4.
    info: Additional info can be set. If empty its value will reflect the app title of the brixxApi object.
  5. 5.
    recordId: If not passed as a parameter the value will be set to record-ID of the brixxApi object (brixxApi.record.id).

Example Usages

brixxApi.logAdd({context: "GroupCriteria", status: "info", text: "Lorem ipsum dolor sit amet, consectetur adipisici elit"})
To remove an existing context from the log for the current brixxApi object logReset is available:
brixxApi.logReset("GroupCriteria")