Skip to main content

LCMS Logs

Overview​

This documentation explains how logs are recorded within the MAXRES Construct platform. Logs capture all actions related to the CRUD (Create, Read, Update, Delete) of data, metadata, content, and assets. Only users with Sys Admin privileges can access the logs, which are stored on the server file system.

Objectives​

By the end of this guide, users will be able to:

  • Understand how logs are recorded and what data they capture.
  • Know how to access the logs with the required permissions.
  • Learn the types of data logged during CRUD operations.

Requirements​

  • Sys Admin privileges to access the server where logs are stored.
  • A file access tool such as WinSCP (optional).

Roles​

This documentation is intended for:

  • System Administrators

Process​

1. How Logs Are Recorded​

Logs are automatically recorded in the background whenever any action involving data, metadata, content, or assets occurs on the platform. These logs serve as a detailed record of all CRUD operations, tracking actions performed by users across the system.

Logs are stored in the Logs folder located on the server file system, ensuring that every significant action is recorded and can be reviewed by system administrators.

2. Data Captured in Logs​

Logs capture a wide range of data related to CRUD operations, including but not limited to:

  • User: The ID or username of the user performing the action.
  • Action: What action was taken (e.g., create, update, delete).
  • Data: The type of data or asset being modified (e.g., content, metadata, assets).
  • UID (Unique Identifier): The unique ID of the content object, metadata, or asset affected by the action.
  • Timestamp: When the action occurred.
  • Old and New Data: The state of the data before and after the action (in case of updates).
  • Metadata and Tags: Any metadata or tags associated with the data that were affected by the operation.

This comprehensive logging ensures that all actions within the platform can be tracked for auditing and troubleshooting purposes.

3. Accessing Logs​

A. Accessing the Server Directly​

  1. Log in to the server
    Use your Sys Admin credentials to access the server where MAXRES Construct is hosted.

  2. Navigate to the Logs Folder
    On the server’s file system, find the Logs folder. This folder contains all recorded log files, typically organized by date or action type.

B. Accessing Logs via WinSCP or Similar Tools​

  1. Open WinSCP
    If you prefer not to access the server directly, you can use a file access tool like WinSCP to connect to the server.

  2. Connect to the Server
    Use your Sys Admin credentials to connect to the server. Once connected, navigate to the Logs folder.

  3. Download or View Log Files
    From WinSCP, you can either download the log files to your local machine for analysis or view them directly within the tool.