Article last updated on the 16th of June 2022.
2.1 Drilling down
The Event Log in WorkPoint is a tool which allows you to follow events happening in the background of your WorkPoint solution. Here, information such as Exceptions and events are displayed, which can be used to monitor the health of a solution, or to investigate possible causes for errors.
2. Using the Event log
The log items are saved up to 3 months. Entries older than these will be removed by automatic maintenance.
Log items can take some time to collect all information required to create show the events. This task is asynchronous and therefore logs will not be available right away. Depending on the level of detail, some log entries may take more than 10 minutes to be available.
For an overall solution overview, simply navigate to the WorkPoint 365 admin interface. From there, find the ‘WorkPoint Event Logging’ menu item in the left menu and click it. You will now see the event page, filtered to only show exceptions (see screenshot below) for the last thirty minutes Subject to change..
2.1 Drilling down
Inspecting a log item
An event will be shown with its most basic log information. Clicking on a log item will open it up and show a more detailed view of the event. As shown in the screenshot below.
Seeing exceptions for the last 30 minutes gives admins an immediate overview of WorkPoint 365 health right now, but using filtering will enable him to view a more detailed report of the solution.
By setting one of the provided time intervals, or manually inputting a custom time frame, admins can check how the system performed various tasks in specific window of time. Please note that we store log items up until a 3-month period. After this, maintenance will automatically clean log entries.
Specifying individual event types (see Event types), using the checkboxes in the upper left corner, will allow admins to focus only on a selected event type. By default, this is only set to exceptions1 when viewing the general event logging page. When showing all Related events, all event types are shown automatically.
Viewing only log items related to a specific type of job is achieved using the ‘Job filter’ control. Admins can filter on all Registered jobs as of December 4th, 2017.
As mentioned in the description of WorkPoint logging scope id, events logged from an iteration of a job will be marked with a common logging scope id. When viewing the log, hovering over a log item will display a link showing ‘Show all related events’, which will filter the log to show all events related to this selected log item, in the period where the job has run. You can see an example of this in the screenshot below.
2.2. Viewing the status of a job
Various actions in WorkPoint 365 result in a job, and inspecting the status of a job is most commonly done through following a link, like the ’View all log entries’ link in the picture below, showing a portion of the Scheduled Jobs page:
- Following this link will take you to the logging page, prefiltered on a specific job, showing all event types in the timeframe of the job.
2.3. Using Event Log Alerts
Event Log Alerts allow administrators to configure alerts for specific events in WorkPoint. Only errors are available as alerts, and alerts can be filtered by job type (e.g. the administrator might only want to receive an alert if a security job fails).
The Alert settings page can be accessed from the Event Log page:
- In the Event Log page, click "Alert Settings".
This opens the Alert Settings page. From here, Alert configurations can be set up:
- Enter the e-mail address of the contact person for the configuration. If alerts regarding the selected jobs are registered, an e-mail will be sent to this contact person. This contact should ideally be a registered user on the solution, as the e-mail sent to this person includes links to the event log in WorkPoint - links which cannot be accessed if the person is not a user of the solution.
- Select the jobs for the configuration. These are the jobs that trigger the sending of an e-mail for the contact person if an alert is registered.
- If you would like to add or remove all jobs at once, click "Select/Unselect all Jobs".
- Click "Add" to add the configuration.
- Click the "Save" button to save the configuration(s).
Multiple configurations can be created, as shown in the following image:
- Administrators can Delete or Edit configurations by clicking the relevant actions for each configuration.
An example of an e-mail sent to a contact, based on an error in the system looks like the following:
Note that in order for the alerts to be sent out, a Scheduled job of type "Alert" must be set up:
- In the "Scheduled Job" page in the WorkPoint 365 Administration, select the "Alert Job" type and click "New Scheduled Job".
- Select how often you want to be alerted by the scheduled job and when it should run the first time. Then click the "Save" button.
You can read more about Scheduled Jobs in this article.