ACI Documentation

User Activity v2

Executive Summary

User Activity v2 is an administrative reporting screen that extracts the usage log of the application into an Excel file. Administrators choose a branch and date range, optionally narrow the log by user, employee, client, visit and application pages, and the system builds a spreadsheet. Each extract is kept as a job on this screen so that the file can be downloaded again and the criteria that produced it can be reviewed. The employee and client searches use AlayaCare.

Key Features

  • Start a new user-activity extract for a branch and date range
  • Narrow the log by user, employee, client, visit ID and application pages
  • Pick pages by menu group, with Select All In Group and Deselect All In Group
  • Review past extract jobs, with start and end times and duration
  • Download the Excel file of a completed job again at any time
  • Open a job to see the criteria used

Typical Workflow

  1. Select a branch at the top of the page (when more than one is available) to see its jobs.
  2. Click Start A New Report.
  3. Set the Date Range and any of the optional filters, and tick the pages to include.
  4. Click Ok and wait for processing. The Excel file downloads when it finishes.
  5. Later, use the Download XLS icon on a row to download it again, or Edit to see which filters were used.

Available Permissions

The following permissions are available to be assigned to AlayaCare Roles:

AttributeWhat It Controls
ViewOpen the page, start extracts, download files and view job details
All BranchesChoose All Branches in the branch selectors

Main Grid

The grid lists the extract jobs for the selected branch, newest first (14 rows per page). The first four columns stay in view when scrolling sideways.

ColumnDescription
IDJob number.
BranchBranch of the extract.
AddedWhen the job was started, in your time zone.
Added ByUser who started the job.
EmployeeEmployee filter used on the job, when set.
ClientClient filter used on the job, when set.
Visit IDVisit filter used on the job, when set.
FromStart of the date range.
ToEnd of the date range.
Processing StartWhen processing began, in your time zone.
Processing EndWhen processing finished, in your time zone.
DurationTime taken to process the job.
CancelledWhen the job was cancelled, if it was.
Manage RecordsContains the Edit and Download XLS buttons.

Main Grid Filters

FilterPurpose
Branch (top right)Limits the list of jobs to the selected branch. Changing it reloads the list.

Actions

ButtonDescription
Start A New ReportOpens the Start A New Report dialog.
Edit (row button)Opens the Details dialog for the job. Works only for jobs that have a file.
Download XLS (row button)Downloads the job's Excel file. Does nothing when the job has no file.
Edit (right-click a row)Opens the Details dialog for the job.
Download (right-click a row)Downloads the job's Excel file.

Dialog Components

Start A New Report

Opens from Start A New Report. Ok starts the extract; use the close icon to leave without starting it.

FieldPurpose
BranchBranch of the extract. Defaults to the branch selected on the page.
Date RangePeriod of the log to extract. Required unless a Filter Visit AC ID is entered.
Filter UserOptional multi-select of users. Only their entries are included.
Filter EmployeeOptional search for one employee (searches AlayaCare within the branch).
Filter ClientOptional search for one client (searches AlayaCare within the branch).
Filter Visit AC IDOptional AlayaCare visit ID. When entered, the log for that visit is used, limited to the date range if one is set.
Select All In Group / Deselect All In GroupTicks or clears every page in the menu group currently shown.
Menu group listList of menu groups. Select one to show its pages.
Menu Title gridPages of the selected menu group. Tick the pages to include; the ticks are kept as you move between groups. When no page is ticked, all pages are included.

Details

Opens from Edit on a job. Shows a read-only summary of the criteria used. Close closes it.

FieldPurpose
Filter BranchBranch of the job.
Filter EmployeeEmployee filter used, when set.
Filter ClientClient filter used, when set.
Filter Visit IDVisit filter used, when set.
Filter PagesPages included.

Dependencies

The following tables must be configured for lookups on this view to work:

TableDescription
BranchesBranches offered in the branch selectors.
Roles and permissions menu list (menu groups and view names)Menu groups and pages offered for selection when starting a report.

Processing Overviews

This section describes what happens after you confirm a processing action.

Start A New Report

  1. Requires a branch, and a date range unless a visit ID is entered ("Please select a valid branch" or "Please select a valid date range" is shown otherwise). Signs in to AlayaCare first; if sign-in fails, nothing is started.
  2. Closes the dialog and shows a progress panel. The panel has a cancel option.
  3. Loads the log entries: the entries for the visit ID (limited to the date range when set) or, without a visit ID, all entries in the date range.
  4. Applies the filters you chose: users, pages, client and employee.
  5. Creates the job, recording the branch, date range, who started it and the criteria used.
  6. Builds an Excel workbook with a General sheet listing the criteria (date range, branch, client, employee, pages, actions, types, users and visit ID) and a Data sheet with one row per entry, newest first: ID, Action Dt, User, Type, Action, View, Client UID, Employee UID, Visit ID, Facility ID, IP Address and Details.
  7. Stores the file on the job, downloads it as UserActivity_{date and time}.xlsx and shows "Exported Successfully". If building the file fails, a warning "Error exporting" with the reason is shown.
  8. Records the processing end time and duration, marks the job Completed (or Cancelled if you cancelled), and reloads the grid.