System Admin UI - department-of-veterans-affairs/caseflow GitHub Wiki
A system admin page exists within Caseflow. This page can be accessed by System Admin Users only. The purpose of this page is initially created so that System Admin users can generate an extract which contains information on veteran updates that will be sent to MPI.
Navigating to System Admin UI
Simply go to /admin
OR when in /test/users
, click on the Miscellaneous tab and then click Admin
Process for generating the extract
The system admin page will contain a button labeled Extract Veterans for MPI
.
Once this button is clicked:
- A System Admin Event is created
- A SQL command will be run to gather data for the extract.
- Note: The most recent System Admin Event that was completed will be compared to the
STADTIME
field in the CORRES table so that only veterans added since are included in the extract.
- Note: The most recent System Admin Event that was completed will be compared to the
- Two scenarios can happen here:
- If the Extract SQL is successful:
completed_at
will be set to the timestamp of when the SQL successfully raninfo
will be set to the number of veterans that were found from the SQL statement
- If an error occurs during the Extract SQL:
errored_at
will be set to the timestamp of when error occurred.
- If the Extract SQL is successful:
- Once the System Admin Event is updated:
- If number of veterans within
info
is not 0, then return data for CSV. - If number of veterans within
info
is 0, return a message stating no new veterans.
- If number of veterans within
Feature Toggle
- sys_admin_page
- A feature toggle that when enables the system admin page to load when enabled.
- vet_extract_timestamp
- Disabling this disables the check against system_admin_event table when looking for veterans for the extract
- vet_extract_pipe_delimited
- When enabled swaps to pipe delimitation for the CSV
- comma is the default