Browse Components - Code Extractor

function ensure_path_exists

Recursively creates a directory path in FileCloud storage by ensuring all parent directories exist before creating child directories.

File: /tf/active/vicechatdev/CDocs/controllers/filecloud_controller.py | Lines: 162-199

filesystem directory-creation recursive filecloud path-management

class FileCloudError

Custom exception class for handling FileCloud-specific errors in the CDocs document management system.

File: /tf/active/vicechatdev/CDocs/controllers/filecloud_controller.py | Lines: 87-89

exception error-handling filecloud integration custom-exception

function reset_filecloud_client

Resets the global FileCloud client connection by setting the global _filecloud_client variable to None, effectively clearing any existing connection state.

File: /tf/active/vicechatdev/CDocs/controllers/filecloud_controller.py | Lines: 82-85

filecloud connection-management reset cleanup global-state

function get_filecloud_client

Singleton factory function that returns a globally cached FileCloud API client instance, handling initialization, authentication, and re-authentication as needed.

File: /tf/active/vicechatdev/CDocs/controllers/filecloud_controller.py | Lines: 42-80

filecloud api-client singleton authentication connection-management

function get_document_training_info

Retrieves comprehensive training information for a specific controlled document, including training configuration, assigned users, completion status, and statistics.

File: /tf/active/vicechatdev/CDocs/controllers/training_controller.py | Lines: 1092-1217

document-management training-tracking neo4j graph-database user-management

function disable_document_training

Disables the training requirement for a specific controlled document, verifying user permissions and logging the action to the audit trail.

File: /tf/active/vicechatdev/CDocs/controllers/training_controller.py | Lines: 1037-1090

training-management document-control permissions audit-logging authorization

function get_training_assignment

Retrieves a specific training assignment for a user from a Neo4j graph database, validating user authorization and parsing a composite UID format.

File: /tf/active/vicechatdev/CDocs/controllers/training_controller.py | Lines: 954-1032

training assignment neo4j graph-database authorization

function get_training_overview

Retrieves a comprehensive training overview for the admin panel, including training plans, active assignments, and recent completions from a Neo4j graph database.

File: /tf/active/vicechatdev/CDocs/controllers/training_controller.py | Lines: 806-951

training admin overview dashboard neo4j

function get_user_training_dashboard

Retrieves a user's training dashboard data by querying Neo4j for required and completed training records associated with controlled documents.

File: /tf/active/vicechatdev/CDocs/controllers/training_controller.py | Lines: 700-803

training dashboard neo4j graph-database user-training

function reset_document_training

Resets all training records for a specific controlled document, typically used when a document is republished or updated, requiring users to retrain.

File: /tf/active/vicechatdev/CDocs/controllers/training_controller.py | Lines: 622-697

training-management document-control quality-management permission-check audit-trail

function get_document_training_assignments

Retrieves training assignments and configuration for a specific controlled document, including assigned users and training requirements.

File: /tf/active/vicechatdev/CDocs/controllers/training_controller.py | Lines: 568-617

training-management document-control permission-check user-assignments compliance

function remove_training_assignment

Removes a training assignment relationship between a user and a controlled document in a Neo4j graph database, with audit logging and permission checks.

File: /tf/active/vicechatdev/CDocs/controllers/training_controller.py | Lines: 450-564

training-management neo4j graph-database relationship-deletion audit-logging

function complete_user_training_by_uid

Completes a user's training assignment for a controlled document by updating the training relationship status, recording completion date and score, and logging the event to the audit trail.

File: /tf/active/vicechatdev/CDocs/controllers/training_controller.py | Lines: 349-446

training-management compliance document-control neo4j graph-database

function complete_user_training

Marks a user's training as complete for a specific controlled document, validating quiz requirements and setting expiration dates.

File: /tf/active/vicechatdev/CDocs/controllers/training_controller.py | Lines: 262-346

training compliance document-management user-training certification

function assign_user_training

Assigns training requirements to multiple users for a specific controlled document, validating permissions, document training status, and user existence before creating assignments.

File: /tf/active/vicechatdev/CDocs/controllers/training_controller.py | Lines: 121-258

training-management document-control user-assignment permission-check audit-logging

function enable_document_training

Enables training requirements for a controlled document, setting validity period, quiz requirements, and instructions for users who need to complete training on the document.

File: /tf/active/vicechatdev/CDocs/controllers/training_controller.py | Lines: 32-116

training document-management compliance authorization audit

function manage_user_share_access

Manages user access permissions (read-only or edit) to a specific document version share in FileCloud, creating the share if it doesn't exist.

File: /tf/active/vicechatdev/CDocs/controllers/filecloud_helper.py | Lines: 16-152

filecloud document-sharing access-control permissions user-management

function get_document_permissions

Retrieves permission information for a specific document by its unique identifier, returning structured data about who can access the document and their permission levels.

File: /tf/active/vicechatdev/CDocs/controllers/api_handler.py | Lines: 90-131

document-management permissions access-control api-endpoint error-handling

function get_document_access

Retrieves document access information for a specific user, including permissions (write access, owner, reviewer, approver status) and share URL.

File: /tf/active/vicechatdev/CDocs/controllers/api_handler.py | Lines: 30-88

document-management access-control permissions api-endpoint authorization

function register_api_routes

Registers API routes for document access and permissions endpoints with Panel's routing system, with error handling and logging.

File: /tf/active/vicechatdev/CDocs/controllers/api_handler.py | Lines: 18-28

api routing panel web-framework initialization