Skip to main content

OC Connect

Core communication and chat functionality module enabling real-time messaging between users.

Features​

  • Real-time Messaging: Instant message delivery using WebSocket connections
  • One-on-One Chat: Private conversations between two users
  • Group Chats: Create and manage group conversations with multiple participants
  • Typing Indicators: See when other users are typing in real-time
  • Presence Status: View online/offline status of users
  • Message History: Full searchable history of all conversations

Requirements​

  • Open Core Business Suite (Base System)
  • Laravel Reverb (for WebSocket support)

Installation​

  1. Download the OC Connect module package
  2. Extract the module to Modules/OCConnect
  3. Run the installation command:
php artisan module:enable OCConnect
php artisan migrate
  1. Configure Laravel Reverb for WebSocket support:
php artisan reverb:start
  1. Clear the application cache:
php artisan optimize:clear

Usage​

One-on-One Messaging​

Start a private conversation with any user:

  • Navigate to Communication > Messages
  • Click on a user to start a conversation
  • Send text messages in real-time
  • View message delivery and read status

Group Chats​

Create and manage group conversations:

  • Click New Group to create a group chat
  • Add participants from your organization
  • Set group name and description
  • Manage group members and settings

Presence Status​

Monitor user availability:

  • Green indicator: User is online
  • Gray indicator: User is offline
  • View last seen timestamps

Typing Indicators​

Real-time feedback when users are composing messages:

  • See typing indicators in active conversations
  • Indicators appear for all participants in group chats

Configuration​

Access module settings at Settings > OC Connect to configure:

  • Message retention period
  • Maximum file attachment size
  • Allowed file types for attachments
  • Notification preferences
  • WebSocket connection settings

Technical Notes​

This module uses Laravel Reverb for WebSocket support, providing:

  • Low-latency real-time communication
  • Automatic reconnection on connection loss
  • Scalable broadcasting infrastructure
  • Secure encrypted connections
Last updated on