OperationsCommander - https://opscom.wiki

Admin Tools & Data Maintenance

Items on the tools menu control rarely accessed but important setup and configuration tools for OPSCOM.  Data Maintenance options are also here.

Data Maintenance Articles

The Data Maintenance tools and processes allow administrators to clean, merge, and archive system records. The primary purpose of these features is to ensure optimal system performance, data accuracy, and ongoing regulatory compliance by eliminating redundancies and outdated information. This article is intended for OPS-COM administrators who are responsible for maintaining overall system health and data integrity.

Setup and Configuration

These maintenance activities do not require a specific initial setup, but they do require high-level administrative access to execute.

Admin Side: Administrators must be granted the appropriate user role permissions within the system settings to access sensitive data management tools, such as purging records, merging accounts, or importing bulk user data.

User Side: These features are strictly backend administrative tools and are not accessible to end-users on the portal.

Using this Feature

Administrators can utilize a variety of tools to maintain their system data. Because data maintenance is a broad category, the specific steps will vary based on the task you are trying to accomplish.

Benefits of Routine Data Maintenance

Keeping your system data well-organized provides several key operational benefits:

Available Data Maintenance Workflows

To perform specific maintenance tasks, please review the step-by-step instructions in the following detailed guides:

Exercise extreme caution when using data maintenance tools like the system purge or user merge functions. These actions are often irreversible. If you are unsure about the impact of a specific maintenance task, contact OPS-COM support for guidance before proceeding.


Best Practices and Considerations

Using the Database Importer (Beta)

The Database Importer provides administrators with a powerful tool to import bulk data into the system using CSV files. Its primary purpose is to facilitate initial data migrations, execute mass record updates, and integrate data from external systems to ensure your database is populated efficiently. This article is intended for OPS-COM administrators responsible for backend data management.

Setup and Configuration

This feature requires specific administrative permissions to access and operate the import tools.

Admin Side: Administrators must have the appropriate permissions enabled under the Systems tab of the permissions management page. For complete instructions on modifying user access, refer to the Manage Roles and Permissions wiki article.

Using this Feature

Administrators can use the following instructions to upload CSV files, match data columns, and initiate the import process.

Accessing the Importer

  1. Hover over Tools and click Data Importer - BETA to access the main management screen.

Importing Data into a Table

  1. Click the Upload button next to the desired destination table.

  2. Select your comma-differentiated or semi-colon-differentiated CSV file from the modal window.

  3. Click the Submit button to begin the file upload and proceed to the table import screen.

  4. Match the columns from your imported CSV file to the corresponding destination columns within the system. The system will automatically pre-select matches if your CSV contains recognized column names.

  5. Click the Process button to initiate the background import process.

The importer has a strict limit of 10,000 records per batch import. This maximum count includes your CSV header row.

Resetting a Table

The Database Importer also allows administrators to completely purge an entire table's contents.

  1. Click the Reset button next to the specific table you wish to empty.

  2. Type DELETE into the confirmation text field in the modal window.

  3. Click the Delete button to permanently purge all records from the selected table.

Resetting a table is an irreversible, permanent action. Once the data is deleted, it cannot be recovered. Additionally, purging primary tables (like vehicles or permits) will automatically purge closely connected join tables (like vehicle joins or permit joins).

Order of Operations for Related Imports

Imports that contain related information must generally be executed in a specific order to ensure dependencies are met and records associate correctly.

Table to Import Requires Prior Import Notes
UserProfile None This should generally be the first table imported.
Vehicles UserProfile Ensures the user record exists so the vehicle can associate via a join record.
OffenceLocations None Must be imported prior to violations for proper location marking.
Permits Vehicles, UserProfile Ensures vehicle and user records exist for permit associations and automated payment marking.
Violations Vehicles, UserProfile, OffenceLocations A violation requires an existing vehicle record to be created, and an existing location to be marked properly.

Unique Identifiers and Duplicate Settings

When importing data, the system uses specific unique identifier columns to determine if a record already exists. If a match is found, the system will follow your selected duplicate setting to either ignore the duplicate (do nothing) or overwrite the existing record with the new CSV data.

Inserting Into Table Column Inserting Into Sourced From Table
UserProfile prov Provinces
UserProfile UserTypeID UserTypes
Vehicle ProvID Provinces
Vehicle ColourID VehicleColours
Vehicle MakeID VehicleMake
Vehicle TypeID VehicleType
Vehicle PlateTypeID VehiclePlateType
Permits LotNameID LotName
Permits StateID PermitState
Violations VehicleID Vehicle
Violations TicketType TicketCategory
Violations LocationID OffenceLocations

Understanding Post Import Processing

After data is inserted into the base table, the system runs separate, automated post-processing to establish relationships.


Best Practices and Considerations

Importer Field Descriptions

The Importer Field Descriptions article provides a comprehensive reference guide to the data fields used within the Using the Database Importer (Beta) tool. Its primary purpose is to help administrators successfully prepare CSV files by detailing column names, internal system names, requirement levels, and data types for each supported table. This article is intended for OPS-COM administrators responsible for large-scale data migrations or updates.

Setup and Configuration

Preparing for a successful data import requires formatting your CSV files to match the system's exact specifications and understanding the strict requirements for different data fields.

Admin Side: Before formatting your CSV file, it is essential to understand the different levels of field requirements:

User Side: End-users do not interact with the database importer or its CSV formatting requirements.

Using this Feature

Administrators reference the tables below to map their external data columns to the corresponding OPS-COM internal names and data types.

UserProfile Table

Column Name Internal Name Requirement Type Description
User Unique ID (UUID) UserUUID Unique ID Standard The primary identifier. If UUID is not supplied, email is used as the key identifier instead. Either this or the email is required.
Email Address email Unique ID Standard The secondary identifier. Either this or the UUID is required to import a record.
Username username Recommended Standard The username of the user.
First Name firstName Recommended Standard The first name of the user.
Middle Name middleName Optional Standard The middle name of the user.
Last Name lastName Recommended Standard The last name of the user.
Password password Optional Standard The password of the user.
User Type UserTypeID Recommended Foreign Key Attaches to the UserTypes table. Values must exactly match the TypeName column (case, spelling, and spacing). Blank if no match is found.
Street Address street Optional Standard The street address of the user.
City city Optional Standard The city of the user.
Province/State prov Optional Foreign Key Attaches to the Provinces table. Values must exactly match the ProvName column (long names, not abbreviations like ON).
Postal Code postal Optional Standard The postal or ZIP code of the user.
Cellphone Number phonecell Optional Standard The cellphone number of the user.
Employee Number employNo Optional Standard The employee number of the user.
Student Number studentNo Optional Standard The student number of the user.
Secondary Phone sPhone Optional Standard The secondary phone number of the user.
Date of Birth DOB Optional Standard The date of birth of the user.
Preferred Name preferredname Optional Standard The preferred name of the user.
Public Comment publicComment Optional Standard Public comment for the user. Visible to the user.
Private Comment privateComment Optional Standard Private comment for the user. Not visible to the user.
Login Source loginSource Optional Standard The method by which the user logs into the system. Defaults to OPSCOM if not supplied.

OffenseLocations Table

Column Name Internal Name Requirement Type Description
Location Name LocationName Unique ID Standard The name of the location being imported. Required to import a record.
Writer Visible WriterVisible Optional Standard Indicates whether the writer of a violation ticket made in the location is visible to the user.
GIS Number GisNo Optional Standard Geographic location code used by certain clients for GIS maps integration.

Vehicle Table

Column Name Internal Name Requirement Type Description
Licence Plate Plate Unique ID Standard The license plate number of the vehicle. Required to import a record.
Vehicle Year Year Optional Standard The manufacturing year of the vehicle.
Active Vehicle active Optional Standard Indicates whether the vehicle is active. Defaults to active if not supplied.
Plate Type Name PlateTypeID Optional Foreign Key Attaches to the VehiclePlateType table. Must be an exact match to the TypeName column.
Province/State ProvID Optional Foreign Key Attaches to the Provinces table. Must be an exact match to the ProvName column (long names only).
Vehicle Make Name MakeID Optional Foreign Key Attaches to the VehicleMake table. Must be an exact match to the MakeName column.
Vehicle Type Name TypeID Optional Foreign Key Attaches to the VehicleType table. Must be an exact match to the TypeName column.
Vehicle Colour Name ColourID Optional Foreign Key Attaches to the VehicleColours table. Must be an exact match to the ColourName column.
VIN Number vin Optional Standard The Vehicle Identification Number (VIN).

Permits Table

Column Name Internal Name Requirement Type Description
Permit Number PermitNo Unique ID Standard First primary identifier. Both this and LotNameID must be provided to create a new permit.
Lot Name (Long) LotNameID Unique ID Foreign Key Second primary identifier. Attaches to the LotNames table. Must be an exact match to the long-form LotName column.
Visible visible Optional Standard Indicates whether the permit is visible or not.
Permit Status status Optional Standard The administrative status of the permit.
Permit State StateID Optional Foreign Key Attaches to the PermitState table.

Violations Table

Column Name Internal Name Requirement Type Description
Ticket Number Ticket Unique ID Standard The unique identifier for the violation. Required to import a record.
Licence Plate VehicleID Recommended Foreign Key Attaches to the Vehicle table. Must be an exact match to the Plate column.
Ticket Type Name TicketType Recommended Foreign Key Attaches to the TicketCategory table. Must be an exact match to the TicketTypeName column.
Fine Amount Fine Recommended Standard The amount of the fine associated with the ticket.
Towing Amount Towing Optional Standard The amount of towing charges associated with the ticket.
Tax Amount taxAmount Optional Standard The amount of tax associated with the ticket.
Issued Date Issued Recommended Standard The date the ticket was issued.
Due Date Due Recommended Standard The due date for payment of the ticket.
Ticket Writer Writer Optional Standard The administrator who wrote the ticket.
Violation Location Name LocationID Recommended Foreign Key Attaches to the OffenceLocations table. Must be an exact match to the LocationName column.

Best Practices and Considerations

Create or Refresh a Preview Space

The Preview Space feature allows administrators to generate a secure, isolated testing environment that mirrors their live production system data. Its primary purpose is to provide a safe sandbox for testing new features, staging system changes, and conducting training without impacting operational data or actual end-users. This article is intended for OPS-COM administrators responsible for managing system testing and training environments.

Setup and Configuration

Preview spaces are generated on demand directly from your live production environment.

Admin Side: Administrators require high-level system access to push data from the live database to a preview environment. No user-side configuration is required, as this is strictly an administrative testing tool.

Using this Feature

Administrators can use the following instructions to generate, access, and manage the active state of their preview database.

Creating or Refreshing a Preview Space

  1. Hover over Tools and click Database to Preview in your live production system.

  2. Select Backup Production Database to capture up-to-date information, or select a specific date from the drop-down menu to use an older historical backup.

  3. Wait for the manual backup process to complete, if applicable.

  4. Click the Refresh Preview Database button to push the data to the testing environment.

The database refresh process typically takes 1 to 2 minutes, but it can take up to 15 minutes depending on the total size of your organization's database. A notification message will display along the top of the screen to alert you when the refresh is officially complete.

Accessing the Preview Space

  1. Open your web browser's address bar.

  2. Insert .preview immediately after your organization's subdomain name and before the main OPS-COM domain (e.g., [https://yourorganization.preview.OPS-COM.com](https://yourorganization.preview.OPS-COM.com)).

  3. Press Enter to navigate to the isolated sandbox environment.

Locking and Unlocking the Database

Administrators can lock the preview database to prevent other staff members from accidentally refreshing the system and overwriting active testing or development work.

  1. Log in to your preview site.

  2. Hover over Tools and click Reset Database.

  3. Toggle the lock or unlock setting as needed.

  4. Enter a justification in the provided reason field when prompted by the system.

Visual Cues and Status Indicators


Best Practices and Considerations

Resolve Duplicate Options

The Resolve Duplicates feature allows administrators to identify and merge duplicate records by email, student number, staff number, and vehicle plate. Its primary purpose is to maintain data accuracy, prevent operational errors, and ensure that enforcement and permit management processes rely on clean, unique data. This article is intended for OPS-COM administrators responsible for system data maintenance and focuses specifically on resolving vehicle duplicates.

Setup and Configuration

This feature is a core administrative data maintenance tool and requires no specialized initial setup.

Admin Side: Administrators must have the appropriate system permissions enabled to access the data maintenance tools and execute merges.

User Side: This feature is strictly a backend administrative tool and is not accessible to end-users on the portal.

Using this Feature

Administrators can use the following instructions to generate a list of duplicate vehicles, select the appropriate retention data, and merge the records.

Resolving Duplicates By Vehicle

  1. Hover over Tools and select Resolve Duplicates, then click By Vehicle.

  2. Select your desired duplicate identification option to generate a list of potential duplicates.

  3. Review the generated list carefully, paying close attention to vehicle descriptions and other details to confirm they are actual duplicates.

  4. Click the Merge button next to the specific pair of duplicate records you wish to consolidate.

  5. Select which specific data fields you wish to retain from the duplicate records in the merge function window.

  6. Finalize the merge to permanently combine the records.

Available Actions and Buttons

The Include Different Plate Types option is highly useful for identifying input errors. For example, if a vehicle was entered once with an unspecified plate type and a second time as a passenger plate, this search criteria will flag them as potential duplicates so you can compare the make, model, and color to confirm.


Best Practices and Considerations

    History Search

    The History Search feature allows administrators to quickly locate and review historical system activities and events. Its primary purpose is to provide a comprehensive log of system interactions, making it an invaluable tool for auditing, troubleshooting, and investigating specific actions related to users, vehicles, or violations. This article is intended for OPS-COM administrators.

    Setup and Configuration

    This feature is a core administrative auditing tool and does not require specific module configuration to begin logging data.

    Admin Side: Administrators must have the appropriate system role permissions enabled to access the Tools menu and view the system history logs.

    User Side: This feature is strictly a backend administrative tool and is not accessible to end-users on the portal.

    Using this Feature

    Administrators can use the following instructions to navigate to the search page and locate specific historical records.

    Performing a History Search

    1. Hover over Tools and click History Search to open the History Dump page.

    2. Enter the desired search criteria into one or more of the available fields.

    3. Click the Submit button.

    4. Review the generated list of all system history records that match your entered search criteria.

    Available Search Criteria

    You can perform a search using a single identifier (such as just a ticket number) or a combination of multiple fields to carefully narrow down your results on the History Dump page.

    Available Actions and Buttons


    Best Practices and Considerations

    Purge Old - Explained

    The Purge Old Data feature allows administrators to remove inactive historical records that have not had any activity associated with them for more than seven years. Its primary purpose is to maintain database efficiency, improve system performance, and ensure data remains relevant by clearing out old, unused information. This article is intended for OPS-COM administrators responsible for system maintenance and data retention.

    Setup and Configuration

    This feature is a core administrative data maintenance tool and requires no specialized initial setup to enable.

    Admin Side: Administrators must have the appropriate system permissions enabled to access the data maintenance tools and execute a system purge.

    User Side: This feature is strictly a backend administrative tool and is not accessible to end-users on the portal.

    Using this Feature

    Administrators can use the following instructions to generate a list of inactive records and execute the system purge.

    Executing a Data Purge

    1. Hover over Tools and click Purge Old Data to initiate the identification process.

    2. Wait for the progress bar to complete as the system compiles a list of any user activity and associated record updates that have occurred within the last seven years.

    3. Review the system prompt indicating the number of inactive records identified for potential purging.

    4. Click the Purge these records button to complete the process and execute the deletion of any data not found on the active list.

    Any small update or activity on a record will automatically restart its seven-year clock. This business rule ensures that the record is excluded from purging and preserved for another seven years from that last activity date.

    Purged Record Types

    The following record types will be permanently purged if they have had no activity in the last seven years:

    Retained Record Types

    The following record types will NOT be purged, regardless of their last updated date, ensuring the retention of critical long-term information:


    Best Practices and Considerations

    Purging Incidents

    The Incident Purging feature allows administrators to permanently remove outdated incident records from the system. Its primary purpose is to maintain data relevance, comply with organizational data retention policies, and optimize overall database performance. This article is intended for OPS-COM administrators responsible for system maintenance and data lifecycle management.

    Setup and Configuration

    This feature requires specific administrative permissions to access the deletion tools.

    Admin Side: Administrators must have the Delete Incidents permission enabled within their specific user role to purge records. Consult your system administrator or review the Manage Roles and Permissions page for detailed instructions on modifying access levels.

    User Side: This feature is strictly a backend administrative tool and is not accessible to end-users on the portal.

    Using this Feature

    Administrators can use the following instructions to purge outdated incidents either individually through a standard search or in bulk using the dedicated purging utility.

    Purging incidents is a permanent and irreversible action. Once an incident is successfully purged from the system, its data cannot be recovered. Exercise extreme caution and verify your selections before confirming any deletion.

    Purging Individual Incidents

    1. Search for the specific incident you wish to purge using the standard incident search functionality.

    2. Review the incident details on the screen and locate the Delete Incident button.

    3. Click the Delete Incident button to initiate the removal.

    4. Follow the on-screen prompts and confirmation messages to finalize the deletion.

    The Delete Incident button will only be active and clickable if the incident record is strictly older than 7 years. If the incident is less than 7 years old, the button will display as Delete Not Available and remain disabled to enforce retention policies.

    Purging Incidents in Bulk

    1. Hover over Tools and click Purge Incidents to open the search screen.

    2. Enter your search criteria into the available fields, such as specific date ranges or incident types.

    3. Review the generated list, which is limited to displaying the oldest 300 records that match your criteria.

    4. Enable the Delete checkbox next to each specific incident you wish to purge.

    5. Click the Purge Records button.

    6. Click the Delete button within the confirmation prompt to finalize the action.

    When entering a value into the Number of Instances field on the bulk search screen, the system treats it as a "greater than or equal to" variable. For example, supplying the number 1 may still display incidents that have multiple instances attached to them.

    Available Actions and Buttons


    Best Practices and Considerations

        Handheld Devices and Commons

        The Handheld Devices and Commons section allows OPS-COM administrators to manage and configure the mobile devices used for field enforcement and data collection. Its primary purpose is to centralize device registration, facilitate message broadcasting to field personnel, and manage device-specific settings to ensure accurate and seamless data synchronization.

        Setup and Configuration

        This feature is a core administrative tool for managing your organization's physical enforcement hardware.

        Admin Side: Administrators must have the appropriate system role permissions enabled to access the device management tools. Furthermore, field devices must have the OPS-COM Android application installed and maintain an active network connection to receive configuration updates and pushed messages from the system.

        Using this Feature

        Administrators can use the device management interface to oversee their fleet of enforcement handhelds, push updates, and register new hardware.

        Managing Devices

        1. Navigate to the Handheld Devices section within your administrative tools.

        2. Review the displayed list of currently registered enforcement devices.

        3. Select a specific device from the list to view its current synchronization status and configuration details.

        Available Actions and Buttons

        This page serves as a high-level overview of the Handheld Devices module. For detailed, step-by-step instructions on configuring specific handheld models, installing the application, or troubleshooting synchronization issues, please refer to the Handhelds Devices Settings (Handheld Commons) wiki article.


        Best Practices and Considerations

        Managing Recurring and Onetime System Tasks

        The Scheduled Tasks feature utilizes both recurring and onetime system tasks to automate various backend processes, such as data synchronization, report generation, and system clean-up. Its primary purpose is to allow administrators to monitor, enable, and disable these critical automated functions, ensuring the efficient operation of the environment. This article is intended for OPS-COM administrators responsible for backend system maintenance.

        Setup and Configuration

        This feature is a core administrative tool and does not require complex initial configuration to access.

        Admin Side: Administrators must have the appropriate system role permissions enabled to access the Tools menu and view system task logs.

        Using this Feature

        Administrators can use the following instructions to access task logs, monitor execution times, and toggle automated tasks on or off.

        Accessing System Tasks

        1. Hover over Tools and click View System Task Logs.

        2. Review the Scheduled Tasks page, which is divided into two main sections: Recurring tasks and Onetime tasks.

        Key Information Displayed

        For each task listed on the page, the system provides several key metrics to help administrators monitor backend performance:

        Available Actions and Buttons

        Please be aware that there are often other module-specific settings that must be configured correctly before enabling a related system task. Ensure you have fully set up the feature before toggling its automated task to active.


        Best Practices and Considerations