Available in: Axsy Mobile for Salesforce, Axsy Field Service, Axsy Public Sector, Axsy Retail Execution
The Home tab of the Axsy Mobile app in the Salesforce Web UI provides access to the Axsy Events Console. The console provides dashboards, charts and other tools for viewing historical event data reported by the Axsy Mobile App. It is designed to be a helpful tool as part of support and troubleshooting activities.
Events Dashboard
The Dashboard tab provides visual charts that provide information and breakdowns on the event data being reported by the Axsy Mobile App. The following time periods are selectable for the event data displayed in the dashboard: Last 24 hours, last 7 days, last 14 days or last 30 days.
NOTE: Event data is only stored for a limited amount of days before it is deleted to free up storage space. The custom setting Axsy Admin > App Event Lifespan (Days) is used to set how many days that data is retained - default is 7 days. A longer value for this setting is required if you want to make use of the longer time periods supported by the Events Dashboard.
Figure 1 – The Events Dashboard comprises of multiple visual charts and graphs
The Event Dashboard includes multiple charts and graphs. A description of each chart is in the table below:
Chart | Description |
|---|---|
| Event Counts and Trends | Provides a total count of Error events, Warning events and All events for the selected time period. Includes a trend indicator based on the previous historical time period. |
| App Versions | Graph depicting the total number of login sessions based on app version. Only the top 3 app versions are depicted separately - all app versions outside the top 3 are grouped together as "older" versions. Hovering over the graph will show the precise counts. |
| Event Metrics - Severity by Hour (Avg) | Hourly breakdown of the average number of Error events and Warning events - depicted as bars with scale to the left - and the average number of All events - depicted as a line with scale to the right. |
| Event Metrics - Severity by Day | Daily breakdown of the total number of Error events and Warning events - depicted as bars with scale to the left - and the total number of All events - depicted as a line with scale to the right. This chart is not displayed if the time period for the dashboard is set to the last 24 hours. |
| Initial Sync Metrics | Average sync metrics across all initial syncs performed for the selected time period, including a bar graph depicting the average number of records synced by object. Hovering over a bar will display the exact average. |
Table 1 – Description of each dashboard chart
Figure 2 – Event Counts and Trends
Figure 3 – App Versions
Figure 4 – Event Metrics and severity by hour (avg)
Figure 5 – Event Metrics and severity by day
Figure 6 – Initial sync average metrics
Scheduled Event Deletion
Since Axsy’s Summer ’22, each Axsy managed package schedules a job: Axsy Scheduled Event Deletion on the Apex class: ScheduledEventDeletion to run each day at 2am.
Due to various known Salesforce Issues, the scheduling for this Apex class may disappear or not run as intended. To resolve this issue you may need to reinstate the scheduling manually. To do so, from Setup → Custom Code → Apex Classes, select Schedule Apex as shown in Figure 7 below.
Figure 7 – Creating a New Scheduled Apex Job
Next specify the Job Name as Axsy Schedule Event Deletion (or similar) and ensure you select ScheduledEventDeletion as the Apex Class and see Figure 8, below, for scheduling details.
Figure 8 – Rescheduling Axsy Scheduled Event Deletion
The ScheduledEventDeletion Apex class will remove up to 10,000 event records each time it runs. If you have > 10,000 event records that need to be deleted to reach the default Axsy Event Lifespan (Days) threshold (typically 7 days), this job will need to run multiple times.
Event List
The Events tab provides the ability to review events that are reported by the Axsy Mobile App. With an in-depth breakdown of what objects, records and other data have been synced, it is possible to pin-point where errors are occurring for troubleshooting purposes.
Filtering the Event List
The list of events displayed can be filtered by:
- Start and End Dates
- Users
- Profiles
- Severity Levels
- Event Types
NOTE: Events that have the severity level of "Warning" are events where at least one request error or long running request has been logged.
Other than the start and end dates, all other filters can have multiple values included, with the absence of any values for any given filter parameter meaning that filter parameter is not applied.
Figure 9 - Events tab showing all reported app events that match the specified filters for profile
The table below provides a description of some typical event types:
Event Type | Description |
|---|---|
| Login | A user has logged in to the app. Includes the app version used for login. |
| Initial Sync | A user has completed the initial sync following login. |
| Logout | A user has logged out of the app |
| Daily Summary | A summary of app usage over the last 24 hours. |
| Memory Warning | App received a memory warning from the device OS. |
| Upload Error | Error returned when uploading a request to the Salesforce Platform. |
Table 2 - Description of some typical event types
Event Details
Selecting the radio button to the left of an event will bring up more information - presented below the event list - about the given event. All events include a General tab with information such as the user, the device and the app version, and a JSON tab that contains the complete information about the event stored as JSON. The JSON can be downloaded as a file for easy sharing as part of any troubleshooting activities. Depending on the event type, a third tab may be available. For example, Initial Sync events will include a third tab with sync statistics such as the sync duration, number of API requests sent and a breakdown of what objects and records were synced. As another example, Upload Error events will include a third tab with the error status code and message.
Figure 10 - Example of the "General" tab for a Logout event
Figure 11 - Example of sync statistics for an Initial Sync event
Figure 12 - Example graph of object totals synced as part of a Initial Sync event
Initial Sync and App Session Metrics
The App Sessions tab provides metrics for initial sync that can be filtered by:
- Start and End Dates
- Users
- Profiles
- App Versions
- Config Versions
- Config Scopes
- Device IDs
- Operating Systems
- OS Versions
Other than the start and end dates, all other filters can have multiple values included, with the absence of any values for any given filter parameter meaning that filter parameter is not applied.
Once any filters have been applied, the number of resulting app sessions will be listed along with the associated number of initial sync events. Across those found initial sync events, metrics will be displayed showing:
- The average number of records per initial sync
- The average number of API requests sent to Salesforce per initial sync
- The average time duration per initial sync
- The average number of long duration API requests sent to Salesforce per initial sync
Figure 13 - App Sessions tab showing average initial sync metrics for all app sessions found that match the specified filters for profile and OS
NOTE: The app session data which is used as source for the initial sync metrics is only stored for a limited amount of days before it is deleted to free up storage space. The custom setting Axsy Admin > Days to keep login session data is used to set how many days that data is retained - the default is 30 days.