Card Admin Documentation

Logging In #

To log in, navigate to card.wvnet.edu in your browser.

Use your active directory (LDAP) credentials to authenticate. The LDAP prefix (wvn\) and LDAP suffix (@wvn.wvnet.edu) are not needed for the user name.

Menu Bar (Admin) #

At the top of any page after logging in, the following options are available:

  • Logo/Brand – “WVNET Entry & Exit Log” in this example. Clicking this will go back to the home page as selected in settings.
  • Views – Different pages to show employees in alternative layouts, or only display a specific department.
  • Show – A set of filters to show/hide employee cards.
  • Messaging (SMS Admins Only) – WVNET’s EMS solution to notify employees, as well as points of contact at Mylan and North Elementary, by email and SMS.
  • Users (Report Viewers Only) – Edit user information, manually sync with LDAP, or add/delete non-ldap users.
  • Reports (Report Viewers Only) – A set of two Argos reports from the database.
    • Data Export Dashboard – A detailed list of activity for employees, filtered by employee(s) and a date range.
    • Summary Dashboard (Not Recommended) – An inaccurate summarization of employee activity grouped by day.
  • Admin (Report Viewers Only)
    • Feedback – Listing of feedback provided by employees.
    • Logs – Listing of changes made to models. For the most part, this should be changes to user attributes.
    • Toolbox – A series of admin information and settings to help debug.
  • Status – A quick dropdown to change your status, or log out of the site. Your current status is deactivated as an option.
    • Remote
    • Conference
    • Out
    • Logout – Not to be confused with Out above, this does not set your status to out. Instead, it logs you out of your current session on the site.
  • Info (Not available in Demo version) – Clicking the “I” icon will show a modal that displays other WVNET contact information, including mailing address and other phone extensions.
  • Settings – Clicking the gear icon will show a modal that lists user settings that can customize the look and layout of the site.
  • Help – Clicking the “?” icon will show a modal with relevant help for the current page. This includes information on the purpose of the page, and actions that can be done.

Messaging #

From any page after logging in, click the “Messaging” link on the menu bar. On this page, previous messages sent out (EMS Alerts or single messages) are listed. Use the dropdown to the left to select a message. The table below will update automatically with a list of recipients and their responses.

Columns:

  • Last Name: The last name for the user.
  • First Name: The first name for the user.
  • Date Replied: The date the confirmation link was clicked, if any.
  • IP: The IP address when the user clicks the confirmation link, if any.
  • Error Flag: An indicator that something went wrong when sending the message. A value of 1 indicates an issue, and a value of 0 indicates all messages to the user were sent successfully.
  • Message: The message associated with the error flag. In the example above, this elaborates that the phone number for the user is not valid. If there is no error, “Success!” is displayed instead.
  • Resend (Not available in Demo): If an invalid or empty phone/email address are associated with the user, a message is displayed here to indicate as such. Otherwise, if the user has not confirmed receiving the message, a Resend button is available. This column is left blank after confirmation has been received.

Sending an EMS Alert #

To send an EMS Alert, press the Send Message on the right side of the page. A modal will appear to compose a new message.

To begin, select one or more groups in the Group dropdown. For the demo, only the “School” organization is available. Other organizations, if available, are listed as options as well. At least one group selected is necessary to send a message.

When typing a message, the counter above will change accordingly.

The limit for a message is 101 characters. This is a restriction for SMS messages, as well as leaving enough space for a shortened confirmation URL for users to click on.

Sending a Single Message #

To send a single message, click on the card for any user on any home page, then Click the SMS button underneath their image. See the previous section for information about message character limits.

For the demo version of the site, the submit button is deactivated.

Receiving and Confirming a Message #

An example of a user receiving an alert via email.

Messages are received via email and SMS. These messages have a URL to click to confirm receiving the message. For emails, this is the “Respond” button. For SMS texts, this is a text link.

Users #

Note: The “Sync LDAP Users” button is deactivated in demo mode.

From any page after logging in, click the “Users” link on the menu bar. This page lists all users registered on the site. It allows you to add new users, edit/delete existing users, and sync users from LDAP. Note that there is a user dropdown on the right side to filter types of users. Those options are:

  • All Users: Includes both active and soft-deleted users.
  • Active Users: Only show users currently in use on the site.
  • Deleted Users: Only show soft-deleted users.

Adding a User #

To add a user, press the “Add User” button on the left side of the page, above the user table.

User adding/editing rules:

  • First Name: Required. Max length 50 characters.
  • Nickname: Max length 50 characters. An optional name to display instead of the first name on the site.
  • Last Name: Required. Max length 50 characters.
  • Title: Max 100 characters.
  • Email address: Required. Max 99 characters. Must be a valid email address.
  • Email address alternative: Max 99 characters. Must be a valid email address. An optional email used in addition to the default when sending out messages.
  • PIK: Required. Max 9 characters. Must be unique among all PIK stored in database. This is the ID used for identifying incoming card swipes from WVU.
  • Cell Phone: Max 10 characters. Additional characters entered (ex. (123) 456-7890) will be removed when saving.
  • Slack ID: Max 9 characters. This is to identify users and allow Slack features.
  • Extension: Max 3 characters.
  • Department: Zero or more departments can be selected. If a user is not in any group, or in a group without a home page, they will only be visible on the user management page.
  • Manager: This is to indicate a manager for a group for department home page sorting purposes.
  • Picture: It is recommended that this is a reasonable resolution for different display sizes, and cropped to a square image. Note: Images uploaded are resized to 125×125 for display on all pages. The original image can be viewed by clicking the image within the Card modal on any home page.
  • Username: This is generated automatically, but only when a new user is created. It is generated using the first letter in their first name, concatenated with their last name.

When done, click the “Add User” button to save your changes.

The page will refresh with a confirmation notification.

Editing a User #

To edit an existing user, click on their row in the user table. A modal will pop up.

Note: In demo mode, saving these changes is not permitted.

Editing LDAP Users #

Below is a mockup when editing LDAP users. Most attributes are deactivated, with the exception of nickname, cell, Slack ID, departments, manager, and image.

Deleting a User #

To delete a user, click on their row to edit them (see the above section). When the modal appears, click the “Delete User” button to soft-delete the user. Soft-deleting means that the user is still in the database, but the site ignores the record unless explicitly told to include it.

After deleting a record, the page will refresh with a confirmation message.

Restoring a User #

To restore a user, use the filter dropdown on the right side of the page, above the search bar. Either use the All Users option, and search for rows highlighted in red text (this indicates deletion), or use the Deleted Users option.

An example of a deleted user record.

Clicking on a deleted user will bring up a modal.

Properties can also be edited, without needing to restore the user.

To restore the user, press the “Restore User” button in the bottom right.

The page will refresh with a confirmation message.

Syncing LDAP Users #

To run, click the “Sync LDAP Users” button on the right. This will sync the following properties from LDAP to the local database.

  • givenName => First Name
  • sn => Last Name
  • mail => Email
  • sAMAccountName => Username
  • ipPhone => Extension
  • employeeID => PIK
  • mobile => cell phone
  • title => title

In addition, the following groups checked to update local group permissions:

  • CN=Entry_Log_Report_Viewers,OU=WVNet Security Groups,DC=wvn,DC=wvnet,DC=edu
  • CN=Entry_Log_Presence_Toggle,OU=WVNet Security Groups,DC=wvn,DC=wvnet,DC=edu
  • CN=Entry_Log_Presence_Time,OU=WVNet Security Groups,DC=wvn,DC=wvnet,DC=edu
  • CN=SMS_Admins,OU=WVNet Security Groups,DC=wvn,DC=wvnet,DC=edu

When synchronizing is done, the page will refresh with a confirmation notification.

Note that the following options are not synchronized via LDAP:

  • Nickname
  • Slack ID
  • Department(s)
  • Manager
  • Picture

In addition, cell phone can be set to a different value locally. Once changed, the synchronization process will skip the cell phone attribute, preserving local changes.

Reports #

Currently, both reports utilize the Argos API and Argos Web Viewer, hosted by WVNET. The account used (wvnetapi) is locked down to only access these reports. URL manipulation in Card will simply redirect back to the home page in Card.

Data Export Dashboard #

Activity Log #

The initial tab selected shows the activity log. This is to export data from the primary activity table, which includes card swipes for all entrances/exits for the office, as well as status changes done via Slack or using the site itself. There are also entries generated by the site automatically. When a user is remote for more than 9 hours, the site will set their status back to out automatically. In addition, users that somehow do not have their status set to “In” but then have their status update in the Data Center log will have an entry generated in the main log automatically. Data Center and denied/bad card swipes are not included. Information includes first name, last name, a timestamp of the event, the location of the event, the status change, author, and IP address (if applicable).

To use, first select a start and end date. This can be set to the same day between both date pickers, which will restrict results to only the 24 hour period in the selected day. Next, the list of users to select will update based on the date range. Only users that had activity in the time period will be visible to select. Click on a user, hold the ctrl key and click on multiple users, or use the ctrl+a key combination to select all users. When done, press the “Run” button to the right to retrieve results.

In the result table below, the gear icon can be pressed for additional options, such as filtering results further, change column order, or export the data to a CSV file.

Click Log #

The next tab will show activity from users clicking on cards on any home page of the site. This information includes the name of the card clicked, the user that clicked the card, the IP address where the user originates from, and the timestamp of when the click occurred. To use, first select a start and end date. This can be set to the same day between both date pickers, which will restrict results to only the 24 hour period in the selected day. Afterwards, press the “Run” button to the right to retrieve results.

In the result table below, the gear icon can be pressed for additional options, such as filtering results further, change column order, or export the data to a CSV file.

Denied Log #

This tab will show activity from the building when a card swipe is not properly read. This information includes the timestamp of when the click occurred, the location in the building where it happened, the status code (which indicates if it was a misread card swipe while attempting to enter or exit the building), and the author (this should usually be “email,” as card swipe information comes from WVU to WVNET via email). To use, first select a start and end date. This can be set to the same day between both date pickers, which will restrict results to only the 24 hour period in the selected day. Afterwards, press the “Run” button to the right to retrieve results.

In the result table below, the gear icon can be pressed for additional options, such as filtering results further, change column order, or export the data to a CSV file.

Data Center Log #


The final tab shows the data center log. This is to export data from the data center table, which only logs users entering/exiting the data center, and automated entries generated by the site. These entries are made when a user forgets to swipe out when leaving the Data Center, but then swipes out to leave the office, or changes their status. Data Center and denied/bad card swipes are not included. Information includes first name, last name, a timestamp of the event, the location of the event, the status change, author, and IP address (if applicable).

To use, first select a start and end date. This can be set to the same day between both date pickers, which will restrict results to only the 24 hour period in the selected day. Next, the list of users to select will update based on the date range. Only users that had activity in the time period will be visible to select. Click on a user, hold the ctrl key and click on multiple users, or use the ctrl+a key combination to select all users. When done, press the “Run” button to the right to retrieve results.

In the result table below, the gear icon can be pressed for additional options, such as filtering results further, change column order, or export the data to a CSV file.

Summary Dashboard #

As noted previously, it is not recommended to use this dashboard. It only calculates based on the first activity in a day and the last activity in a day. It does not account for any breaks midday or for those working overnight.

To use, first select a start and end date. This can be set to the same day between both date pickers, which will restrict results to only the 24 hour period in the selected day. Next, the list of users to select will update based on the date range. Only users that had activity in the time period will be visible to select. Click on a user, hold the ctrl key and click on multiple users, or use the ctrl+a key combination to select all users. When done, press the “Run” button to the right to retrieve results.

In the result table below, the gear icon can be pressed for additional options, such as filtering results further, change column order, or export the data to a CSV file.

Admin #

The following are options only available to those in the SMS Admin group.

Feedback #

On this page, feedback left by users can be viewed. When feedback is submitted, the first and last name, the message, date of feedback, and IP address are logged.

Logs #

On this page, logs are kept for actions performed on user models. This includes adding, editing, deleting, or restoring users. Synchronizing LDAP users will also record log entries. Admins starting or ending a session impersonating another user are logged (see Change User section below). Finally, card swipes from PIK numbers not recognized are added in this table.

Toolbox #

This section covers features available in the administrative toolbox: a set of features meant to help with debugging and testing.

User Info #

This tab shows all information stored in the current session. Includes all default values from Laravel as well as custom session values.

User LDAP Info #

In the next tab, properties from LDAP are listed for the currently signed in user. The dropdown to the right can be used to load information for different users via ajax.

Session Info #

This tab includes all session variables.

PHP Info #

PHP information, including the current version installed on the server, is listed here. Useful to confirm which version the server/site is currently using without needing to SSH into the server.

Routes #

A list of all routes available on the site, including API routes. The URL path, Laravel name, Controller function, and any middleware used are included.

Change User #

This tab allows admins to test or debug features as other, non-admin users. It can be particularly useful to double check conditionals for showing/hiding elements on pages, or to confirm middleware logic is working properly.

After changing to a user, a banner appears at the top of the page.

As seen in the screenshot above, the example user has no administrative access, so links are hidden. In order to restore the user session to the previous user, a banner is placed at the top of each page, with a button to end the session that the user is impersonating.

Change Background #

This allows admins to test new backgrounds or changes to existing backgrounds, without needing to modify JS files or run commands in the dev console. This puts a setting into the user session to override the current background used on the site, which is based on the date. A revert button is found here as well to restore the default behavior.

Test Site #

On sites meant for testing, there is a banner above the top of the page indicating as such. This is to help developers identify versions of the site that are safe to modify data on without fear of harming production environments.

Demo Site #

The current demo site can be found at the following link: https://dlesdev.wvnet.edu/carddemo/home/main

WVNET employees can log into the demo site using their LDAP credentials. However, employees will likely not be visible on the home pages as their user is not assigned to any group.

On the demo site, the following features are disabled, modified, or otherwise limited:

  • Images for users are randomized.
  • EMS and single messages will not send out messages via SMS. This is prevent use of EZTexting credits.
  • Further, the send message button is deactivated.
  • Certain WVNET-specific home pages are hidden and inaccessible.
  • Argos reports are inaccessible.
  • WVNET information modal is inaccessible.
  • Resend button is never an available option when viewing messages.
  • Adding/editing users is not possible.
  • Custom background is permanently turned off in demo.
  • Syncing LDAP users is not an available option.
  • Slack and Email API routes are not available in demo.
  • Various routes related to points above are not available as well. This way, even if a user manipulates the page to submit a form, no changes can be saved.

Powered by BetterDocs

Leave a Reply