Skip to main content
Version: Next

Viewing Logs

What is the Logs System?​

The Logs system in AI SCADA automatically records user actions, system events, and equipment operations. It provides an audit trail for troubleshooting, compliance, and security purposes.

The system uses a pre-built runtime component that requires minimal configuration—simply add it to a view and start reviewing logs.

When to Use Logs?​

The Logs system is essential for:

  • Troubleshooting: Identify when and why issues occurred
  • Audit Compliance: Meet regulatory requirements for activity tracking
  • Security Monitoring: Track user access and actions
  • Change Tracking: Review who made changes and when
  • Performance Analysis: Identify patterns in system usage
  • Incident Investigation: Reconstruct events leading to problems

Log Types​

The system provides three types of logs:

1. Login Logs​

Records user authentication events.

Captured Information:

  • Username
  • Login timestamp
  • Logout timestamp
  • Session duration
  • Login result (success/failure)
  • IP address (if applicable)

Use Cases:

  • Monitor user access patterns
  • Detect unauthorized access attempts
  • Verify user presence during incidents
  • Audit compliance reporting

2. Equipment Logs​

Records tag write operations to equipment.

Captured Information:

  • Tag name
  • Previous value
  • New value
  • Timestamp
  • User who made the change
  • Source (manual input, script, recipe, etc.)

Use Cases:

  • Track parameter changes
  • Identify who modified setpoints
  • Troubleshoot unexpected equipment behavior
  • Verify recipe application

3. Module Logs​

Records operations in runtime modules.

Captured Information:

  • Module name (Recipe Management, Permissions, etc.)
  • Operation type (create, edit, delete, apply, etc.)
  • Affected entity (recipe name, user name, etc.)
  • Timestamp
  • User who performed operation
  • Operation result (success/failure)

Use Cases:

  • Track recipe changes
  • Monitor permission modifications
  • Review alarm acknowledgments
  • Audit data table operations

Adding the Logs Component​

Step 1: Create a Logs View​

  1. Create a new view in the View Editor
  2. Name it "Logs" or "Audit Trail"
  3. Navigate to Components > Runtime > Logs Management
  4. Drag the component to the canvas
  5. Resize to fill the view
  6. Save the view

📷 [Screenshot: Logs Management component in View Editor]

Step 2: Add to Navigation​

  1. Add the view to your main menu or navigation
  2. Restrict access to authorized personnel (supervisors, engineers, administrators)
  3. Save changes

Step 3: Run the Application​

  1. Click Run to start the runtime
  2. Navigate to the Logs view
  3. The component is ready to use

📷 [Screenshot: Logs Management interface in runtime]

Viewing Login Logs​

Track user authentication events.

Access Login Logs​

  1. Open the Logs Management view
  2. Click the Login Logs tab
  3. View the list of login/logout events

📷 [Screenshot: Login Logs tab showing user sessions]

Login Log Columns​

ColumnDescription
UsernameUser account name
Login TimeWhen user logged in
Logout TimeWhen user logged out (empty if still logged in)
DurationSession length
StatusSuccess or Failure
IP AddressClient IP address (if available)

Filter Login Logs​

Use filters to find specific login events:

By User:

  • Select username from dropdown
  • View all sessions for that user

By Date Range:

  • Set start date and end date
  • View logins within time period

By Status:

  • Filter by successful or failed logins
  • Identify unauthorized access attempts

💡 Tip: Review failed login attempts regularly to detect potential security issues.

Common Login Log Queries​

Who is currently logged in?

  • Filter by empty Logout Time
  • Shows active sessions

When did a user last log in?

  • Filter by username
  • Sort by Login Time descending
  • First entry is most recent

How many failed login attempts today?

  • Filter by Status = Failure
  • Filter by Date = Today
  • Count results

Viewing Equipment Logs​

Track tag write operations to equipment.

Access Equipment Logs​

  1. Open the Logs Management view
  2. Click the Equipment Logs tab
  3. View the list of tag write operations

📷 [Screenshot: Equipment Logs tab showing tag changes]

Equipment Log Columns​

ColumnDescription
TimestampWhen change occurred
Tag NameFull tag path
Previous ValueValue before change
New ValueValue after change
UserWho made the change
SourceHow change was made (manual, script, recipe, etc.)

Filter Equipment Logs​

Use filters to find specific equipment operations:

By Tag:

  • Enter tag name or pattern
  • View all changes to that tag

By User:

  • Select username
  • View all changes made by that user

By Date Range:

  • Set start and end dates
  • View changes within time period

By Value Range:

  • Filter by value thresholds
  • Find when values exceeded limits

Common Equipment Log Queries​

When was this setpoint last changed?

  • Filter by tag name
  • Sort by Timestamp descending
  • First entry is most recent change

Who changed this parameter?

  • Filter by tag name and date range
  • Review User column

What was the value before the change?

  • Filter by tag name and timestamp
  • Review Previous Value column

How often is this tag being written?

  • Filter by tag name and date range
  • Count entries

💡 Tip: Use equipment logs to troubleshoot unexpected equipment behavior by reviewing recent parameter changes.

Viewing Module Logs​

Track operations in runtime modules.

Access Module Logs​

  1. Open the Logs Management view
  2. Click the Module Logs tab
  3. View the list of module operations

📷 [Screenshot: Module Logs tab showing module operations]

Module Log Columns​

ColumnDescription
TimestampWhen operation occurred
ModuleModule name (Recipe, Permissions, Alarms, etc.)
OperationAction performed (create, edit, delete, apply, etc.)
EntityAffected item (recipe name, user name, etc.)
UserWho performed operation
ResultSuccess or Failure
DetailsAdditional information

Filter Module Logs​

Use filters to find specific module operations:

By Module:

  • Select module from dropdown
  • View all operations for that module

By Operation:

  • Select operation type
  • View all create, edit, or delete operations

By User:

  • Select username
  • View all operations by that user

By Date Range:

  • Set start and end dates
  • View operations within time period

Common Module Log Queries​

When was this recipe last applied?

  • Filter by Module = Recipe Management
  • Filter by Operation = Apply Recipe
  • Filter by Entity = recipe name
  • Sort by Timestamp descending

Who created this user account?

  • Filter by Module = Permissions
  • Filter by Operation = Create User
  • Filter by Entity = username

What changes were made to alarms today?

  • Filter by Module = Alarm Management
  • Filter by Date = Today
  • Review all operations

How many recipes were modified this week?

  • Filter by Module = Recipe Management
  • Filter by Operation = Edit Recipe
  • Filter by Date Range = This Week
  • Count unique entities

Exporting Logs​

Export logs for external analysis or archival.

Export Logs​

  1. Select the log type tab (Login, Equipment, or Module)
  2. Apply filters to select logs to export
  3. Click Export button
  4. Select export format:
    • Excel (.xlsx)
    • CSV (.csv)
    • PDF (for reports)
  5. Choose save location
  6. Click Save

📷 [Screenshot: Export dialog with format options]

Export Uses:

  • Compliance reporting
  • External analysis (Excel, database)
  • Long-term archival
  • Incident investigation reports

💡 Tip: Export logs regularly for backup and archival purposes.

Log Retention and Management​

Automatic Log Retention​

The system automatically manages log storage:

Default Retention Periods:

  • Login Logs: 90 days
  • Equipment Logs: 30 days
  • Module Logs: 90 days

Automatic Cleanup:

  • Logs older than retention period are automatically deleted
  • Cleanup runs daily at midnight
  • Prevents database from growing indefinitely

⚠️ Caution: Export important logs before they are automatically deleted.

Configure Retention Periods​

Adjust retention periods in system settings:

  1. Navigate to System Settings > Logs
  2. Set retention period for each log type
  3. Click Save

Considerations:

  • Longer retention requires more storage
  • Compliance requirements may mandate minimum retention
  • Balance storage costs with audit needs

Manual Log Cleanup​

Manually delete old logs if needed:

  1. Open Logs Management view
  2. Select log type tab
  3. Filter by date range to delete
  4. Click Delete button
  5. Confirm deletion

⚠️ Caution: Deleted logs cannot be recovered. Export before deleting if needed.

Best Practices​

Regular Review​

Daily Checks:

  • Review failed login attempts
  • Check for unusual equipment changes
  • Monitor critical parameter modifications

Weekly Reviews:

  • Analyze login patterns
  • Review module operation trends
  • Identify potential security issues

Monthly Audits:

  • Generate compliance reports
  • Review user access patterns
  • Archive important logs

Security Monitoring​

Watch For:

  • Multiple failed login attempts (potential brute force)
  • Logins at unusual times
  • Unexpected parameter changes
  • Unauthorized module operations

Response Actions:

  • Investigate suspicious activity immediately
  • Disable compromised accounts
  • Review and strengthen security policies
  • Document incidents

Compliance​

Regulatory Requirements:

  • Understand retention requirements for your industry
  • Configure retention periods accordingly
  • Export logs for long-term archival
  • Maintain audit trail documentation

Audit Preparation:

  • Keep logs organized and accessible
  • Document log review procedures
  • Train personnel on log interpretation
  • Maintain chain of custody for exported logs

Performance​

Optimize Log Storage:

  • Set appropriate retention periods
  • Archive old logs to external storage
  • Monitor database size
  • Clean up unnecessary logs

Query Performance:

  • Use filters to limit result sets
  • Avoid querying entire log history
  • Export large datasets for offline analysis
  • Index frequently queried fields

Troubleshooting​

Logs Not Appearing​

Problem: Recent actions are not showing in logs.

Possible Causes:

  1. Logging is disabled
  2. Database connection issue
  3. Insufficient permissions

Solutions:

  1. Check system settings for logging configuration
  2. Verify database connection
  3. Ensure user has permission to view logs
  4. Refresh the logs view
  5. Check system logs for errors

Cannot Export Logs​

Problem: Export button is disabled or export fails.

Possible Causes:

  1. No logs selected
  2. Insufficient permissions
  3. Disk space full
  4. File path invalid

Solutions:

  1. Apply filters to select logs to export
  2. Verify user has export permissions
  3. Check available disk space
  4. Choose valid save location
  5. Try different export format

Logs Missing for Specific User​

Problem: No logs appear for a particular user.

Possible Causes:

  1. User has not performed any actions
  2. User account was recently created
  3. Logs were deleted
  4. Filter is too restrictive

Solutions:

  1. Verify user has logged in and performed actions
  2. Check date range filter
  3. Remove other filters
  4. Check if logs were archived or deleted

Performance Issues​

Problem: Logs view is slow to load or filter.

Possible Causes:

  1. Too many logs in database
  2. No filters applied (querying all logs)
  3. Database performance issue

Solutions:

  1. Apply date range filter to limit results
  2. Clean up old logs
  3. Export and archive old logs
  4. Optimize database (contact administrator)
  5. Increase retention cleanup frequency

Next Steps​

Now that you know how to view and manage logs, explore:

Last updated on