AddOn

Log and search user actions in the database

Key Features

Log actions with timestamps and types
Search action history by type, term, and date range
SQL database backed storage
Web UI for viewing action logs

Server-Side Usage: // Get the ActionLog API var ActionLog = js.getObject("/OpenForum/AddOn/ActionLog","ActionLog.sjs"); // Log an action ActionLog.logAction("USER_LOGIN", "User john.doe logged in"); // Search actions var results = ActionLog.search("USER_LOGIN", "john", fromTimestamp, toTimestamp); Configuration

Requires SQL database configured
Uses `action_log` table

Action Log - Quick Reference

/OpenForum/AddOn/ActionLog Sevice API Version 0.0.7

Get Actions

Action search

Parameters

Name	Description
actionType (required=false)	{{parameter.description}}
term (required=false)	{{parameter.description}}
fromTs (required=false)	{{parameter.description}}
toTs (required=false)	{{parameter.description}}

Example Get Request

/OpenForum/AddOn/ActionLog?action=search

Example Response

Example Error Response

Action getActionTypes

Parameters

Name	Description
(required=true)	{{parameter.description}}

Example Get Request

/OpenForum/AddOn/ActionLog?action=getActionTypes

Example Response

Example Error Response

Post Actions

Action logAction

Parameters

Name	Description
actionType (required=true)	{{parameter.description}}
action (required=true)	{{parameter.description}}

Example Post Request

/OpenForum/AddOn/ActionLog?action=logAction

Example Response

Example Error Response

Monitor and alert on triggers, heartbeats, and alarms

Key Features

Three alert types: Triggers, Heart Beat monitors, and Alarms
Configurable alert and escalation times
Tag-based alert organization
State tracking (OK, Triggered, Escalated)
Web UI for alert management

Alert Types:

- - Trigger** - Fires when specific condition occurs

- Heart Monitor** - Monitors periodic heartbeat signals

- Alarm** - Time-based alarm notifications

Server-Side Usage: // Get the Alert API var Alert = js.getObject("/OpenForum/AddOn/Alert","Alert.sjs"); // Add an alert Alert.addAlert("ServerHealth", "heartMonitor", 60000, 300000); // Trigger an alert Alert.trigger("ServerHealth"); // Send heartbeat Alert.beat("ServerHealth"); // Get alerts by tag var alerts = Alert.getAlerts("production");

/OpenForum/AddOn/Alert Sevice API Version 1.0.7

Get Actions

Action getAlerts

Parameters

Name	Description
tag (required=false)	{{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=getAlerts

Example Response

Example Error Response

Action addAlert

Parameters

Name	Description
name (required=true)	{{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=addAlert

Example Response

Example Error Response

Action removeAlert

Parameters

Name	Description
name (required=true)	{{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=removeAlert

Example Response

Example Error Response

Action triggerAlert

Parameters

Name	Description
name (required=true)	{{parameter.description}}
reason (required=true)	{{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=triggerAlert

Example Response

Example Error Response

Action beatAlert

Parameters

Name	Description
name (required=true)	{{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=beatAlert

Example Response

Example Error Response

Action cancelAlert

Parameters

Name	Description
name (required=true)	{{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=cancelAlert

Example Response

Example Error Response

Action getAlert

Parameters

Name	Description
name (required=true)	{{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=getAlert

Example Response

Example Error Response

Action getTags

Parameters

Name	Description
alertName (required=true)	{{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=getTags

Example Response

Example Error Response

Post Actions

Create and manage temporary anonymous user sessions

Key Features

Generate unique session keys for anonymous users
Optional password protection
Session prefix customization
Database-backed session storage
Web UI for session creation

Server-Side Usage: // Get the AnonymousSession API var AnonymousSession = js.getObject("/OpenForum/AddOn/AnonymousSession","AnonymousSession.sjs"); // Generate a session var session = AnonymousSession.generateSession("GuestUser", "password123"); // Returns: {sessionId: "abc12345", name: "GuestUser", password: "..."} // Generate session without password var session = AnonymousSession.generateSession("GuestUser", null); Use Cases

Temporary user access
Guest accounts
Time-limited sessions

//OpenForum/AddOn/AnonymousSession/get.sjs

var action = transaction.getParameter("action"); if(action===null) { transaction.setResult(transaction.SHOW_PAGE); return; } try{ action = ""+action; result = {result: "error", message: "Action "+action+" not recognised."}; var AnonymousSession = js.getObject("/OpenForum/AddOn/AnonymousSession","AnonymousSession.sjs"); if(action==="generateSession") { var name = transaction.getParameter("name"); if(name===null) { delete name; } else { name = "" + name; } var password = transaction.getParameter("password"); if(password===null) { delete password; } else { password = "" + password; } var fob = transaction.getParameter("fob"); if(fob===null) { delete fob; } else { fob = "" + fob; } var fobPassword = transaction.getParameter("fobPassword"); if(fobPassword===null) { delete fobPassword; } else { fobPassword = "" + fobPassword; } var returned = AnonymousSession.generateSession( name,password, fob, fobPassword ); if(returned) result = {result: "ok", message: "Performed action "+action, data: returned}; } if(action==="validateSession") { var key = transaction.getParameter("key"); if(key===null) { delete key; } else { key = "" + key; } var password = transaction.getParameter("password"); if(password===null) { delete password; } else { password = "" + password; } var returned = AnonymousSession.validateSession( key, password ); if(returned) result = {result: "ok", message: "Performed action "+action, data: returned}; } if(action==="getFobSessions") { var fob = transaction.getParameter("fob"); if(fob===null) { delete fob; } else { fob = "" + fob; } var fobPassword = transaction.getParameter("fobPassword"); if(fobPassword===null) { delete fobPassword; } else { fobPassword = "" + fobPassword; } var returned = AnonymousSession.getFobSessions( fob, fobPassword ); if(returned) result = {result: "ok", message: "Performed action "+action, data: returned}; } } catch(e) { transaction.sendJSON( JSON.stringify({result: "error",message: "Error:"+e+" on line "+e.lineNumber+" of "+e.sourceName})); return; } transaction.sendJSON( JSON.stringify(result) );

Audio recording and playback functionality

Key Features

Audio recording capabilities
Audio playback support
Integration with AudioMonitor, AudioNotePad, and AudioRecorder sub-addons

Sub-AddOns:

Audio AddOn

Backup OpenForum pages to remote sites

Key Features

Backup pages to remote OpenForum instances
Potential Google Drive integration
Scheduled backup support

Status

In development - see main page for current status

Use Cases

Disaster recovery
Content synchronization
Remote site mirroring

Backup AddOn

An add on to back up a set of open-forum pages to a remote site. Maybe Google Drive or another Open Forum instance ?

Barcode scanning and generation functionality

Key Features

Barcode scanning via camera
Barcode generation
Multiple barcode format support

Sub-Pages

Scanner - Scan barcodes with device camera
Generator - Generate barcode images

Use Cases

Inventory management
Product identification
Asset tracking

Scanner

Generator

Scan barcodes using device camera with Quagga.js library

Key Features

EAN barcode scanning
Real-time camera feed
JavaScript library integration
Capture and display scanned codes

Client-Side Usage: // Include the scanner script OpenForum.includeScript("/OpenForum/AddOn/BarcodeScanner/BarcodeScanner.js"); // Initialize in your OpenForum.init function OpenForum.init = function() { BarcodeScanner.getScanner(document.getElementById("yourElement"), function(code) { console.log('Scanned:', code); }, function(scanner) { // Optional: Keep reference to scanner } ); };

QuickReference

The barcode scanner makes use of the Quagga javascript library.

We have chosen to only capture EAN barcodes at present.

Quick Start Code

In your pages page.js file, include the barcode scanner script. If you want to keep a reference to your barcode scanner, add a variable to hold it.

OpenForum.includeScript("/OpenForum/AddOn/BarcodeScanner/BarcodeScanner.js"); var barcodeScanner;

Within your OpenForum init function, request a barcode scanner, passing it the element where you want the video feed to be displayed and the function you want called when a barcode has been detected.

If you want to keep a reference to your barcode scanner, add a callback function to recieve a reference to the created scanner.

The scanner will immediately start scanning for barcodes. When one is found, the callback function will be called passing in the code.

OpenForum.init = function() { BarcodeScanner.getScanner( document.getElementById("yourElement"), lookup, function(scanner) { barcodeScanner = scanner; });

Calendar display and event management

Key Features

Interactive calendar view
Event display and management
Month/day/week views
Client-side calendar rendering

Client-Side Usage: // Calendar is rendered in #calendarView element // See page.js for initialization details Use Cases

Event scheduling
Date selection
Availability display

//OpenForum/AddOn/Calendar/QuickReference/page.js

Create and manage task checklists with inline editing

Key Features

Add, edit, remove tasks
Reorder tasks (move up/down)
Save task lists to JSON
Data-bound table interface

Client-Side Usage: // Define task template var rowTemplate = { task: "" }; // Initialize tasks array var tasks = <a href="/OpenForum/AddOn/CheckList/QuickReference/" target="newTab"><img src='/OpenForum/Images/icons/png/link_go.png' /></a>; // Load existing tasks OpenForum.loadJSON('/YourPage/tasks.json', function(data) { tasks = data || <a href="/OpenForum/AddOn/CheckList/QuickReference/" target="newTab"><img src='/OpenForum/Images/icons/png/link_go.png' /></a>; }); // Save tasks OpenForum.saveJSON('/YourPage/tasks.json', tasks); Use Cases

To-do lists
Task tracking
Workflow checklists

//OpenForum/AddOn/CheckList/QuickReference/page.js

Claude AI integration with Model Context Protocol (MCP) support

Key Features

MCP server and client implementation
Claude Desktop integration
AI context management
Message queue monitoring
Tool creation and management
Content generation support
Giraffe.js graphics library integration

Server-Side Usage: // Get ClaudeMCP API var ClaudeMCP = js.getObject("/OpenForum/AddOn/ClaudeMCP","ClaudeMCP.sjs"); // Work with MCP tools and contexts Key Resources

Use Cases

AI-powered automation
Content generation
Interactive AI tools
Graphics creation

See main ClaudeMCP Hub for full documentation

Send SMS messages via ClickSend API

Key Features

SMS sending functionality
ClickSend API integration
Message delivery tracking

Server-Side Usage: // Get ClickSendSMS API var ClickSendSMS = js.getObject("/OpenForum/AddOn/ClickSendSMS","ClickSendSMS.sjs"); // Send SMS (implementation depends on ClickSendSMS API) // ClickSendSMS.sendSMS(phoneNumber, message); Configuration

Requires ClickSend API credentials
See ClickSend documentation for setup

Use Cases

Notifications
Alerts
Two-factor authentication

Visual content editor for creating and editing page content

Key Features

Block-based content editing
Visual page builder
Drag-and-drop interface
Multiple content block types

Client-Side Usage: // Content editor is initialized in #pageEditor element // See page.js for initialization details Use Cases

Page creation
Content layout design
Visual editing
Block-based content management

//OpenForum/AddOn/ContentEditor/QuickReference/page.js

OpenForum.init = function() { };

DataCentral Quick Reference

Central data management and table-based data storage

Key Features

Table-based data organization
JSON data storage
CRUD operations on datasets
Web UI for data management

Client-Side Usage: // Uses OpenForum Table extension // Data stored in table format // See table-definition.txt for structure Use Cases

Central data repository
Shared data storage
Structured data management

//OpenForum/AddOn/DataCentral/QuickReference/page.js

DataLogger Quick Reference

Log and store data events and messages

Key Features

Data logging to message queue
Data storage functionality
Log message viewing
Test interface for debugging

Server-Side Usage: // Get DataLogger API var DataLogger = js.getObject("/OpenForum/AddOn/DataLogger","DataLogger.sjs"); // Log data DataLogger.log("Event message", dataObject); // Store data DataLogger.store("dataKey", dataObject); Use Cases

Event logging
Data persistence
Debug logging
Message tracking

DataTransformer Quick Reference

Transform text and data using JavaScript with visual editor

Key Features

Input/Output text editors
JavaScript transformation scripts
Helper functions for common operations
Live transformation execution
Example transformations included
No server-side data sharing

Helper Functions: // Convert data to lines var lines = DT.toLines(data, rowSeparator); // defaults: input, "<br/>n" // Lines to string var str = DT.linesToString(lines, separator); // default separator: "<br/>n" // Apply function to each line var result = DT.forEachLine(function(line) { return line.toUpperCase(); }, data); // Convert to table (2D array) var table = DT.toTable(data, rowSeparator, cellSeparator); // defaults: "<br/>n", "<br/>t" // Table to string var str = DT.tableToString(table, rowSeparator, cellSeparator); // Constants DT.NL // newline character DT.TAB // tab character Transformation Script: // Input text available as 'input' variable // Set 'output' variable with transformed result output = input.toUpperCase(); // Simple example The data transformer takes text from the input and transforms it using JavaScript, then places it in the output. No data is shared or sent to our server unless you choose to save it. Examples:

//An example of transorming data from an xml document

//Comment out or remove this if you have valid xml in the input editor
input = "<a><b val=<br/>"123<br/>">345</b></a>";

//Generate an xml parser by reusing the javascript html dom parser
var parser = new DOMParser();

//Javascript is happier using json objects rather than xml
//This method converts an xml document string to a json object
function xmlStringToJson( data ) {
  //parse a string into an xml document object
  var xml = parser.parseFromString(data, "application/xml");
  //convert that object into json
  return xml2json(xml);
}

//Takes an xml document object and converts it into a json object
//It does not include any xml node parameters, so in the example string above
//val="123" will be ignored and only 345 included
function xml2json(xml) {
  try {
    var obj = {};
    if (xml.children.length > 0) {
      for (var i = 0; i < xml.children.length; i++) {
        var item = xml.children.item(i);
        var nodeName = item.nodeName;

if (typeof (obj<a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/DataTransformer/QuickReference/nodeName"target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/DataTransformer/QuickReference/nodeName does not exist. Click to create it.">nodeName</a>) == "undefined") {
          obj<a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/DataTransformer/QuickReference/nodeName"target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/DataTransformer/QuickReference/nodeName does not exist. Click to create it.">nodeName</a> = xml2json(item);
        } else {
          if (typeof (obj<a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/DataTransformer/QuickReference/nodeName"target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/DataTransformer/QuickReference/nodeName does not exist. Click to create it.">nodeName</a>.push) == "undefined") {
            var old = obj<a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/DataTransformer/QuickReference/nodeName"target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/DataTransformer/QuickReference/nodeName does not exist. Click to create it.">nodeName</a>;

obj<a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/DataTransformer/QuickReference/nodeName"target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/DataTransformer/QuickReference/nodeName does not exist. Click to create it.">nodeName</a> = <a href="/OpenForum/AddOn/DataTransformer/QuickReference/" target="newTab"><img src='/OpenForum/Images/icons/png/link_go.png' /></a>;
            obj<a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/DataTransformer/QuickReference/nodeName"target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/DataTransformer/QuickReference/nodeName does not exist. Click to create it.">nodeName</a>.push(old);
          }
          obj<a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/DataTransformer/QuickReference/nodeName"target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/DataTransformer/QuickReference/nodeName does not exist. Click to create it.">nodeName</a>.push(xml2json(item));
        }
      }
    } else {
      obj = xml.textContent;
    }
    return obj;
  } catch (e) {
    console.log(e.message);
  }
}

var xml = xmlStringToJson( input );

output = JSON.stringify( xml, null, 4 );

//Add a message to the log
print("I've finished");

//An example of transorming data from a csv

//Comment out or remove this if you have valid a csv file in the input editor
input = "a,b,c<br/>n1,2,3<br/>n4,5,6";

//Separate the csv rows
var rows = input.split("<br/>n");
var DELIMITER = ","; //Use "<br/>t" for tab separated

output = "";

print("Rows:" + rows.length);

for(var r in rows) {
  //Ignore the title row
  if( r==0 ) continue;
  
  //Separate each row into a row of cells
  var cells = rows<a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/DataTransformer/QuickReference/r"target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/DataTransformer/QuickReference/r does not exist. Click to create it.">r</a>.split(DELIMITER);
  
  //Create a list of cells
  for(var c in cells) {
  	output += cells<a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/DataTransformer/QuickReference/c"target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/DataTransformer/QuickReference/c does not exist. Click to create it.">c</a> + " : ";  
  }
}

//Add a message to the log
print("I've finished");

Desktop Quick Reference

Remote desktop interface for managing OpenForum instances

Key Features

Tree-based navigation
Tab-based multi-page interface
Remote instance management
Host selection
Real-time updates with clock

Client-Side Usage: // Desktop loads with tree navigation and tab interface // Select host via modal dialog // Navigate pages via tree view // Manage multiple tabs Use Cases

Remote administration
Multi-instance management
Centralized control interface

//OpenForum/AddOn/Desktop/QuickReference/page.js

Developer Quick Reference

Manage developer resource links and file references

Key Features

Store and manage developer file references
Link storage pages to target pages
File name tracking
Editable table interface

Use Cases

Developer resource management
File reference tracking
Quick access to development files
Cross-page file linking

//OpenForum/AddOn/Developer/QuickReference/page.js

DifferenceView Quick Reference

Visual file difference viewer with syntax highlighting

Key Features

Side-by-side file comparison
Syntax highlighting
Line-by-line diff display
Visual change indicators

Client-Side Usage: // Diff viewer rendered in #fileDiff element // See page.js for initialization details Use Cases

Code review
Version comparison
Change tracking
Merge conflict resolution

//OpenForum/AddOn/DifferenceView/QuickReference/page.js

DocumentGenerator Quick Reference

Generate PDF documents from HTML content

Key Features

HTML to PDF conversion
A4 page format support
Header and footer templates
Canvas-based preview
Client-side PDF generation

Client-Side Usage: // Generate PDF from element PdfGenerator.generatePdf(document.getElementById('doc'), 'example.pdf'); // Structure your document // <div class="A4Page"> // <div class="A4Header">Header content</div> // <div>Main content</div> // <div class="A4Footer">Footer content</div> // </div> Use Cases

Document generation
Report creation
Invoice generation
Certificate creation

//OpenForum/AddOn/DocumentGenerator/QuickReference/page.js

Central hub for OpenForum editor tools

Key Features

Links to all editor tools
Content Editor access
Menu Editor access
Page Template Editor access

Available Editors:

Content Editor - Visual block-based page editor
Menu Editor - Navigation menu configuration
Page Template Editor - Template design and management

Use Cases

Quick access to editing tools
Centralized editor navigation

ElasticSearch Quick Reference

Search and index OpenForum pages using ElasticSearch

Key Features

Full-text search across all OpenForum pages
Index page content and attachments
Interactive query builder with tree navigation
Advanced query capabilities (wildcards, boolean operators)
Real-time indexing of page updates

Server-Side Usage: // Get the ElasticSearch API var ElasticSearch = js.getObject("/OpenForum/AddOn/ElasticSearch","ElasticSearch.sjs"); // Index a page ElasticSearch.indexPage("/MyPage"); // Search for pages var results = ElasticSearch.search("search query"); // Delete from index ElasticSearch.deletePage("/MyPage"); Client-Side Usage: // Search using the REST API JSON.get('/OpenForum/AddOn/ElasticSearch/Search', null, 'query=search terms') .onSuccess(function(results) { console.log('Found:', results); }).go(); Configuration

Configure ElasticSearch server connection in AddOn settings
Index location and update frequency configurable
Supports multiple index types (pages, attachments, metadata)

ImageCleaner Quick Reference

Clean up and optimize image attachments in OpenForum

Key Features

Remove unused image attachments
Identify orphaned images not referenced in pages
Batch cleanup operations
Preview images before deletion
Configurable cleanup rules

Server-Side Usage: // Get the ImageCleaner API var ImageCleaner = js.getObject("/OpenForum/AddOn/ImageCleaner","ImageCleaner.sjs"); // Find orphaned images on a page var orphans = ImageCleaner.findOrphanedImages("/MyPage"); // Clean orphaned images ImageCleaner.cleanOrphanedImages("/MyPage"); // Get image usage report var report = ImageCleaner.getImageReport("/MyPage"); Client-Side Usage: // Scan for orphaned images JSON.get('/OpenForum/AddOn/ImageCleaner/Scan', null, 'pageName=/MyPage') .onSuccess(function(result) { console.log('Orphaned images:', result); }).go(); Configuration

Runs as a background service
Configurable scan schedule
Safe mode prevents accidental deletion

ImageProcessor Quick Reference

Upload, process, and categorize images in OpenForum

Key Features

Batch image upload and processing
Automatic image categorization and tagging
Thumbnail generation
Image format conversion
EXIF data extraction
Organize images by category

Server-Side Usage: // Get the ImageProcessor API var ImageProcessor = js.getObject("/OpenForum/AddOn/ImageProcessor","ImageProcessor.sjs"); // Process uploaded image ImageProcessor.processImage("/MyPage", "image.jpg", { createThumbnail: true, maxWidth: 1024, category: "photos" }); // Generate thumbnail ImageProcessor.createThumbnail("/MyPage", "image.jpg", 200, 200); // Extract EXIF data var exif = ImageProcessor.getExifData("/MyPage", "image.jpg"); Client-Side Upload: // Upload and process image var formData = new FormData(); formData.append('image', fileInput.files<a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/ImageProcessor/QuickReference/0"target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/ImageProcessor/QuickReference/0 does not exist. Click to create it.">0</a>); formData.append('category', 'photos'); JSON.post('/OpenForum/AddOn/ImageProcessor/Upload', null, formData) .onSuccess(function(result) { console.log('Image processed:', result); }).go(); Configuration

Configure thumbnail sizes and quality
Set default image categories
Define processing rules and filters

Send emails from server-side JavaScript using SMTP

Key Features

Send emails to single or multiple recipients
HTML and plain text email support
Configurable SMTP settings
Uses admin email configuration

Server-Side Usage: // Get the Mailer API var Mailer = js.getObject("/OpenForum/AddOn/Mailer","Mailer.sjs"); // Send email to single recipient Mailer.sendEmail("user@example.com", "Subject", "Email content"); // Send email to multiple recipients Mailer.sendEmail(<a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/Mailer/QuickReference/"user1@example.com", "user2@example.com""target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/Mailer/QuickReference/"user1@example.com", "user2@example.com" does not exist. Click to create it.">"user1@example.com", "user2@example.com"</a>, "Subject", "Email content"); Configuration

Admin email settings stored in `/OpenForum/Users/Admin/mailer.config`
Requires SMTP server configuration

Mailer Quick Reference

Notes

MemberServices Quick Reference

User authentication, registration, and member management system

Key Features

User registration and login
Password management and reset
Email verification
Member profile management
Role-based access control
Session management
Remember me functionality

Server-Side Usage: // Get the MemberServices API var MemberServices = js.getObject("/OpenForum/AddOn/MemberServices","MemberServices.sjs"); // Register new member MemberServices.register("username", "email@example.com", "password"); // Authenticate user var authenticated = MemberServices.authenticate("username", "password"); // Get member details var member = MemberServices.getMember("username"); // Update member profile MemberServices.updateProfile("username", { email: "newemail@example.com", displayName: "Display Name" }); // Check if user has role var hasRole = MemberServices.hasRole("username", "admin"); Client-Side Usage: // Login JSON.post('/OpenForum/AddOn/MemberServices/Login', null, 'username=myuser&password=mypass') .onSuccess(function(result) { console.log('Logged in:', result); }).go(); // Register JSON.post('/OpenForum/AddOn/MemberServices/Register', null, 'username=newuser&email=user@example.com&password=pass123') .onSuccess(function(result) { console.log('Registered:', result); }).go(); // Get current user JSON.get('/OpenForum/AddOn/MemberServices/CurrentUser') .onSuccess(function(user) { console.log('Current user:', user); }).go(); Configuration

Email verification settings
Password strength requirements
Session timeout configuration
Default roles for new members

MenuEditor Quick Reference

Visual editor for creating and managing hierarchical navigation menus

Key Features

Drag-and-drop menu structure editing
Tree-based menu visualization
Create multi-level menu hierarchies
Save menus as JSON definitions
Load and edit existing menu definitions
Live preview of menu structure

Server-Side Usage: // Get the MenuEditor API var MenuEditor = js.getObject("/OpenForum/AddOn/MenuEditor","MenuEditor.sjs"); // Load menu definition var menu = MenuEditor.loadMenu("/MyPage", "menu.json"); // Save menu definition MenuEditor.saveMenu("/MyPage", "menu.json", menuData); // Create menu structure var menuStructure = { name: "Main Menu", children: <a href=" {name: "Home", link: "/Home"}, {name: "About", link: "/About"} " target="external_page"> {name: "Home", link: "/Home"}, {name: "About", link: "/About"} </a> }; MenuEditor.saveMenu("/MyPage", "menu.json", menuStructure); Client-Side Usage: // Load menu JSON.get('/OpenForum/AddOn/MenuEditor/Load', null, 'pageName=/MyPage&fileName=menu.json') .onSuccess(function(menu) { console.log('Menu loaded:', menu); }).go(); // Save menu JSON.post('/OpenForum/AddOn/MenuEditor/Save', null, 'pageName=/MyPage&fileName=menu.json&data=' JSON.stringify(menuData)) .onSuccess(function(result) { console.log('Menu saved'); }).go(); Menu Definition Format { "name": "Root", "children": <img src=" {"name": "Item 1", "link": "/Page1"}, {"name": "Item 2", "link": "/Page2", "children": <a href="/OpenForum/AddOn/MenuEditor/QuickReference/" target="newTab"><img src='/OpenForum/Images/icons/png/link_go.png' /></a> {"name": "Sub Item", "link": "/Page3"} "/> } ] }

NotePad Quick Reference

Voice-enabled text editor with speech recognition and commands

Key Features

Voice input and dictation
Voice commands for text editing
Text-to-speech read back
Rich text editing
Undo/redo support
Cursor navigation by voice
Special character insertion by voice

Voice Commands

System: start listening, stop listening, save, help, read back, stop reading
Editing: undo, retype, delete line, backspace, delete word
Cursor: left, right, up, down, word left/right, line start/end, select all
Characters: next line, comma, full stop, question mark, quotes, brackets, tab, bullet point

Server-Side Usage: // Get the NotePad API var NotePad = js.getObject("/OpenForum/AddOn/NotePad","NotePad.sjs"); // Save note NotePad.saveNote("/MyPage", "note.txt", "Note content"); // Load note var content = NotePad.loadNote("/MyPage", "note.txt"); Client-Side Usage: // Save note via API JSON.post('/OpenForum/AddOn/NotePad/Save', null, 'pageName=/MyPage&fileName=note.txt&content=' encodeURIComponent(noteContent)) .onSuccess(function(result) { console.log('Note saved'); }).go(); // Load note JSON.get('/OpenForum/AddOn/NotePad/Load', null, 'pageName=/MyPage&fileName=note.txt') .onSuccess(function(content) { console.log('Note loaded:', content); }).go(); Configuration

Voice recognition uses browser Web Speech API
Requires microphone permissions
Customizable voice commands

OddJob Quick Reference

Service for running large batch processing tasks in manageable chunks over multiple cycles

Key Features

Process large lists in chunks to avoid timeouts
Resume processing across server restarts
Monitor progress in real-time
Queue-based task processing
Configurable chunk size and timing
Server-side JavaScript processing

Server-Side Usage: // Create an OddJob processor (TestOddJob.sjs example) var processor = { init: function(config) { // Initialize processor return true; }, processItem: function(item, context) { // Process single item from list console.log("Processing: " item); return {success: true, message: "Processed " item}; }, complete: function(context) { // Called when all items processed console.log("OddJob complete"); } }; // Configuration file (odd-job.config.json) { "processor": "/OpenForum/AddOn/OddJob/TestOddJob.sjs", "chunkSize": 10, "delayBetweenChunks": 1000, "list": { "pageName": "/OpenForum/AddOn/OddJob", "fileName": "my-list.json" } } Client-Side Usage: // Start OddJob JSON.post('/OpenForum/AddOn/OddJob/Start', null, 'pageName=/MyPage&configFile=odd-job.config.json') .onSuccess(function(result) { console.log('OddJob started'); }).go(); // Stop OddJob JSON.post('/OpenForum/AddOn/OddJob/Stop') .onSuccess(function(result) { console.log('OddJob stopped'); }).go(); // Get status JSON.get('/OpenForum/AddOn/OddJob/Status') .onSuccess(function(status) { console.log('Progress:', status); }).go(); Configuration

Define processor script location
Set chunk size (items per cycle)
Configure delay between chunks (milliseconds)
Specify list file location
List format: JSON array of items to process

Packager Quick Reference

Package OpenForum pages and attachments for distribution and deployment

Key Features

Create distributable page packages
Bundle pages with all attachments
Export page hierarchies
Import packages to other OpenForum instances
Version control for page packages
Dependency tracking

Server-Side Usage: // Get the Packager API var Packager = js.getObject("/OpenForum/AddOn/Packager","Packager.sjs"); // Create package from page Packager.createPackage("/MyPage", "/Packages/my-package.zip"); // Create package with specific files Packager.createPackage("/MyPage", "/Packages/my-package.zip", { includeAttachments: true, includeChildren: true }); // Extract package Packager.extractPackage("/Packages/my-package.zip", "/DestinationPage"); // List package contents var contents = Packager.listPackageContents("/Packages/my-package.zip"); Client-Side Usage: // Create package JSON.post('/OpenForum/AddOn/Packager/Create', null, 'pageName=/MyPage&outputFile=my-package.zip') .onSuccess(function(result) { console.log('Package created:', result); }).go(); // Extract package JSON.post('/OpenForum/AddOn/Packager/Extract', null, 'packageFile=my-package.zip&destination=/MyPage') .onSuccess(function(result) { console.log('Package extracted'); }).go(); Package Format

ZIP archive containing page.content, data.json, and attachments
Preserves page structure and metadata
Includes dependency information

Configuration

Configure default package location
Set inclusion/exclusion rules
Define package metadata

PageTemplateEditor Quick Reference

Visual editor for creating and managing page templates with drag-and-drop components

Key Features

Drag-and-drop template designer
Tree-based template structure visualization
Create reusable page templates
Component library integration
Save templates as JSON definitions
Load and edit existing templates
Live preview of template structure

Server-Side Usage: // Get the PageTemplateEditor API var PageTemplateEditor = js.getObject("/OpenForum/AddOn/PageTemplateEditor","PageTemplateEditor.sjs"); // Load template definition var template = PageTemplateEditor.loadTemplate("/MyPage", "template.json"); // Save template definition PageTemplateEditor.saveTemplate("/MyPage", "template.json", templateData); // Apply template to page PageTemplateEditor.applyTemplate("/TargetPage", templateData); // Create template structure var templateStructure = { name: "My Template", components: <a href=" {type: "header", content: "Welcome"}, {type: "content", layout: "two-column"} " target="external_page"> {type: "header", content: "Welcome"}, {type: "content", layout: "two-column"} </a> }; PageTemplateEditor.saveTemplate("/MyPage", "template.json", templateStructure); Client-Side Usage: // Load template JSON.get('/OpenForum/AddOn/PageTemplateEditor/Load', null, 'pageName=/MyPage&fileName=template.json') .onSuccess(function(template) { console.log('Template loaded:', template); }).go(); // Save template JSON.post('/OpenForum/AddOn/PageTemplateEditor/Save', null, 'pageName=/MyPage&fileName=template.json&data=' JSON.stringify(templateData)) .onSuccess(function(result) { console.log('Template saved'); }).go(); Template Definition Format { "name": "Template Name", "components": <img src=" {"type": "header", "content": "Header Text"}, {"type": "section", "layout": "grid", "children": <a href="/OpenForum/AddOn/PageTemplateEditor/QuickReference/" target="newTab"><img src='/OpenForum/Images/icons/png/link_go.png' /></a> {"type": "component", "content": "Component content"} "/> } ] }

PaperScape Quick Reference

Interactive HTML5 canvas-based visualization and drawing tool

Key Features

HTML5 canvas drawing and rendering
Interactive visual elements
Custom visualization creation
Event-driven interaction model
Editable canvas objects
Modal form integration for editing
Real-time rendering

Server-Side Usage: // Get the PaperScape API var PaperScape = js.getObject("/OpenForum/AddOn/PaperScape","PaperScape.sjs"); // Save canvas data PaperScape.saveCanvas("/MyPage", "canvas.json", canvasData); // Load canvas data var canvas = PaperScape.loadCanvas("/MyPage", "canvas.json"); // Export canvas as image PaperScape.exportImage("/MyPage", "canvas.json", "output.png"); Client-Side Usage: // Initialize PaperScape canvas var canvas = document.getElementById('paperScapeCanvas'); var context = canvas.getContext('2d'); // Save canvas state JSON.post('/OpenForum/AddOn/PaperScape/Save', null, 'pageName=/MyPage&fileName=canvas.json&data=' JSON.stringify(canvasState)) .onSuccess(function(result) { console.log('Canvas saved'); }).go(); // Load canvas state JSON.get('/OpenForum/AddOn/PaperScape/Load', null, 'pageName=/MyPage&fileName=canvas.json') .onSuccess(function(canvasData) { // Render canvas from data renderCanvas(canvasData); }).go(); Canvas Data Format { "objects": <a href=" { "type": "rectangle", "x": 100, "y": 100, "width": 200, "height": 150, "color": "#ff0000" }, { "type": "circle", "x": 300, "y": 300, "radius": 50, "color": "#00ff00" } " target="external_page"> { "type": "rectangle", "x": 100, "y": 100, "width": 200, "height": 150, "color": "#ff0000" }, { "type": "circle", "x": 300, "y": 300, "radius": 50, "color": "#00ff00" } </a> } Configuration

Canvas size and background color
Interactive editing enabled/disabled
Object types and properties
Event handlers for canvas interactions

QuickReference

(

Publisher promotes any /... page hierarchy to production by copying it without the /Development prefix so work-in-progress stays isolated.

Every text-based attachment is rewritten so `"/"` links become live paths, and optional rules in `development-translation.sjs` can further transform each file.

Practice publishes generate release notes plus a deletions script preview without touching the live site; the real publish copies files and appends removal commands into `process-deletions.sjs` for manual execution.

Actions

Check for Page Differences – Compares timestamps and hashes between the /Development tree and its published counterpart so you can see what will change.
Reverse Publish – Copies the published page back into /Development to recover live edits or restart from a known-good state.
Publish Page (practice) – Runs the full translation/diff pipeline, writes detailed release notes, but skips copying so you can verify the impact.
Publish Page (for real) – Performs the same checks and then copies the files, applies path rewrites, generates release notes, and refreshes the published page.

Special files

development-translation.sjs – Optional script invoked per text file; receives the file contents as `data` and must return the transformed string.
publish-config.json – JSON blob for exclusions, e.g. `{"excludedFiles":"do-not-publish.me"}`; also expands the standard exclusion list.
do-not-release.txt – Presence blocks publishing and should describe why the page is locked.
process-deletions.sjs – Auto-generated script listing live files to delete after you verify them; run manually once you are satisfied.
release-notes.html.fragment – Captures the accordion-style log of each publish run for auditing.

Usage tips

Publish from the root /... page you want to release; sub pages are handled automatically.
Always inspect the practice-mode release notes before running the real publish so you catch unexpected deletions or TODO markers.
Keep the generated deletions script in source control (or review it) before executing so you have an audit trail of removed files.

Quiz Quick Reference

Interactive quiz system with questions, answers, and photo support

Key Features

Create interactive quizzes
Multiple choice questions
Photo/image integration
Score tracking
Timer support
Question randomization
Result summary and feedback
Modal photo viewer

Server-Side Usage: // Get the Quiz API var Quiz = js.getObject("/OpenForum/AddOn/Quiz","Quiz.sjs"); // Create quiz var quizData = { title: "My Quiz", questions: <img src=" { question: "What is 2 2?", answers: <a href="/OpenForum/AddOn/Quiz/QuickReference/" target="newTab"><img src='/OpenForum/Images/icons/png/link_go.png' /></a>"3", "4", "5""/>, correct: 1, photo: "question1.jpg" } ] }; Quiz.saveQuiz("/MyPage", "quiz.json", quizData); // Load quiz var quiz = Quiz.loadQuiz("/MyPage", "quiz.json"); // Get quiz results var results = Quiz.getResults("quizId", "userId"); Client-Side Usage: // Load quiz JSON.get('/OpenForum/AddOn/Quiz/Load', null, 'pageName=/MyPage&fileName=quiz.json') .onSuccess(function(quiz) { console.log('Quiz loaded:', quiz); }).go(); // Submit quiz answers JSON.post('/OpenForum/AddOn/Quiz/Submit', null, 'quizId=quiz123&answers=' JSON.stringify(userAnswers)) .onSuccess(function(result) { console.log('Score:', result.score); }).go(); Quiz Data Format { "title": "Quiz Title", "timer": 300, "questions": <img src=" { "question": "Question text?", "answers": <a href="/OpenForum/AddOn/Quiz/QuickReference/" target="newTab"><img src='/OpenForum/Images/icons/png/link_go.png' /></a>"Option 1", "Option 2", "Option 3""/>, "correct": 1, "photo": "photo.jpg", "explanation": "Why this answer is correct" } ] } Configuration

Timer duration (seconds)
Randomize questions
Show correct answers after completion
Photo modal display

RPi Quick Reference

Raspberry Pi integration tools and utilities for OpenForum

Key Features

Raspberry Pi GPIO control
Hardware interface integration
Sensor data collection
Remote Pi management
System monitoring and control
Pi-specific services and tools

Server-Side Usage: // Get the RPi API var RPi = js.getObject("/OpenForum/AddOn/RPi","RPi.sjs"); // Control GPIO pins RPi.setGPIO(17, true); // Set pin 17 HIGH var state = RPi.getGPIO(17); // Read pin 17 // Read sensor data var temperature = RPi.readTemperature(); var humidity = RPi.readHumidity(); // System commands var cpuTemp = RPi.getCPUTemperature(); var systemInfo = RPi.getSystemInfo(); Client-Side Usage: // Control GPIO via API JSON.post('/OpenForum/AddOn/RPi/GPIO', null, 'pin=17&state=HIGH') .onSuccess(function(result) { console.log('GPIO set'); }).go(); // Read sensor data JSON.get('/OpenForum/AddOn/RPi/Sensor', null, 'type=temperature') .onSuccess(function(data) { console.log('Temperature:', data.value); }).go(); // Get system status JSON.get('/OpenForum/AddOn/RPi/Status') .onSuccess(function(status) { console.log('CPU Temp:', status.cpuTemp); }).go(); Configuration

GPIO pin mapping
Sensor types and connections
Update intervals
Alert thresholds

RSSRenderer Quick Reference

Fetch, parse, and render RSS feeds as HTML content

Key Features

Fetch and parse RSS feeds
Convert RSS to HTML
Cache feed content
Automatic feed updates
Customizable rendering templates
Multiple feed support
Force update capability

Server-Side Usage: // Get the RSSRenderer API var RSSRenderer = js.getObject("/OpenForum/AddOn/RSSRenderer","RSSRenderer.sjs"); // Fetch and render RSS feed RSSRenderer.updateRSS( "/MyPage", // Page to store RSS "feed.rss", // RSS file name "/MyPage", // Target page "rss.html", // Output HTML file "https://example.com/rss", // RSS feed URL false // Force update ); // Get RSS feed data var feedData = RSSRenderer.getRSSFeed("/MyPage", "feed.rss"); // Parse RSS to HTML var html = RSSRenderer.renderRSS(feedData); Client-Side Usage: // Update RSS feed via URL var url = '/OpenForum/AddOn/RSSRenderer' '?action=updateRSS' '&pageName=/MyPage' '&fileName=feed.rss' '&targetPageName=/MyPage' '&targetFileName=rss.html' '&forceUpdate=true'; JSON.get(url) .onSuccess(function(result) { console.log('RSS updated'); }).go(); // Fetch and display RSS JSON.get('/OpenForum/AddOn/RSSRenderer/Fetch', null, 'url=' encodeURIComponent('https://example.com/rss')) .onSuccess(function(html) { document.getElementById('rssContent').innerHTML = html; }).go(); Parameters

pageName = Page to store RSS data
fileName = RSS file name
targetPageName = Page for rendered HTML
targetFileName = Output HTML file
url = RSS feed URL (optional if already stored)
forceUpdate = Skip cache and fetch fresh (true/false)

Configuration

Update frequency
Cache duration
Rendering template
Feed item limit

ReleasedPackages Quick Reference

Package and release OpenForum pages for deployment to other sites

Key Features

Create versioned release packages
Track release history and versions
Package pages with all dependencies
Release notes management
Pre-release and post-install scripts
Exclude files from releases
Remove old releases
View release package information

Server-Side Usage: // Get the ReleasedPackages API var ReleasedPackages = js.getObject("/OpenForum/AddOn/ReleasedPackages","ReleasedPackages.sjs"); // Release a page ReleasedPackages.releasePage("/MyPage", "1.0.0", "Release notes"); // Get release information var releaseInfo = ReleasedPackages.getReleaseInfo("/MyPage", "1.0.0"); // List all releases var releases = ReleasedPackages.listReleases(); // Remove a release ReleasedPackages.removeRelease("/MyPage", "1.0.0"); // Get release package var packageData = ReleasedPackages.getPackage("/MyPage", "1.0.0"); Client-Side Usage: // Release a page JSON.post('/OpenForum/AddOn/ReleasedPackages/Release', null, 'pageName=/MyPage&version=1.0.0&notes=' encodeURIComponent('Release notes')) .onSuccess(function(result) { console.log('Page released:', result); }).go(); // List releases JSON.get('/OpenForum/AddOn/ReleasedPackages/List') .onSuccess(function(releases) { console.log('Releases:', releases); }).go(); // Remove release JSON.post('/OpenForum/AddOn/ReleasedPackages/Remove', null, 'pageName=/MyPage&version=1.0.0') .onSuccess(function(result) { console.log('Release removed'); }).go(); Special Files

pre-release.sjs - Script run on releasing server before the release package is built
release-excludes-files.json - List of files to exclude from release (supports regex like `.*-test.js`)
release-info.json - Contains release information (version, timestamp, notes)
install.sjs - Run on target server after package installation

Release Process 1. Create release notes for the version 2. Optional: Add page-specific notes 3. Run pre-release.sjs (if present) for validation 4. Create ZIP package excluding specified files 5. Store release with version number and timestamp 6. Generate release-info.json metadata Configuration

Version numbering scheme
Release storage location
Excluded file patterns
Notification settings

RemoteAdministration Quick Reference

Remote administration and management of OpenForum servers

Key Features

Remote server management
Execute administrative tasks remotely
Monitor server status
Manage multiple OpenForum instances
Remote configuration updates
Server health checks
User management across servers

Server-Side Usage: // Get the RemoteAdministration API var RemoteAdmin = js.getObject("/OpenForum/AddOn/RemoteAdministration","RemoteAdministration.sjs"); // Execute remote command RemoteAdmin.executeCommand("serverUrl", "command", parameters); // Get server status var status = RemoteAdmin.getServerStatus("serverUrl"); // Update remote configuration RemoteAdmin.updateConfig("serverUrl", configData); // Manage remote users RemoteAdmin.createUser("serverUrl", "username", "password"); RemoteAdmin.deleteUser("serverUrl", "username"); Client-Side Usage: // Execute remote command JSON.post('/OpenForum/AddOn/RemoteAdministration/Execute', null, 'server=' encodeURIComponent('https://remote-server.com') '&command=restart') .onSuccess(function(result) { console.log('Command executed:', result); }).go(); // Get server status JSON.get('/OpenForum/AddOn/RemoteAdministration/Status', null, 'server=' encodeURIComponent('https://remote-server.com')) .onSuccess(function(status) { console.log('Server status:', status); }).go(); Configuration

Authorized server list
Authentication credentials
Command permissions
Timeout settings
SSL/TLS configuration

RemoteLogger Quick Reference

Centralized logging system for collecting logs from remote OpenForum servers

Key Features

Collect logs from remote servers
Centralized log aggregation
Remote error tracking
Log filtering and search
Real-time log streaming
Log level management
Multi-server log consolidation

Server-Side Usage: // Get the RemoteLogger API var RemoteLogger = js.getObject("/OpenForum/AddOn/RemoteLogger","RemoteLogger.sjs"); // Send log to remote logger RemoteLogger.log("INFO", "My log message"); RemoteLogger.error("Error message"); RemoteLogger.warn("Warning message"); RemoteLogger.debug("Debug message"); // Log with context RemoteLogger.log("INFO", "User action", { user: "username", action: "login", timestamp: new Date().getTime() }); // Get logs var logs = RemoteLogger.getLogs({ level: "ERROR", startTime: startTimestamp, endTime: endTimestamp }); Client-Side Usage: // Send log message JSON.post('/OpenForum/AddOn/RemoteLogger/Log', null, 'level=INFO&message=' encodeURIComponent('Log message')) .onSuccess(function(result) { console.log('Log sent'); }).go(); // Get logs JSON.get('/OpenForum/AddOn/RemoteLogger/Get', null, 'level=ERROR&limit=100') .onSuccess(function(logs) { console.log('Logs:', logs); }).go(); Log Levels

DEBUG - Detailed debugging information
INFO - General informational messages
WARN - Warning messages
ERROR - Error messages
FATAL - Critical error messages

Configuration

Remote logger endpoint URL
Log level filtering
Log retention period
Maximum log size
Authentication credentials

SQL Quick Reference

Database access and SQL query builder for OpenForum

Key Features

Execute SQL queries from server-side JavaScript
Built-in SQL query builder
Support for SELECT, INSERT, UPDATE, DELETE, UPSERT operations
Parameterized queries to prevent SQL injection
Multiple database connection support via aliases
Interactive SQL editor with syntax highlighting
Database inspector with table/column browser
Query history tracking
Code generator for SQL and JavaScript

Server-Side Usage: // Include DB.sjs on your sjs file var DB = js.getObject("/OpenForum/AddOn/SQL","DB.sjs"); DB.setAlias("your database name"); // Create a new DB object for each database you need access to Simple DB Select var sql = { action: "select", table: "my_table", columns: <a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/SQL/QuickReference/"column_a", "column_b""target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/SQL/QuickReference/"column_a", "column_b" does not exist. Click to create it.">"column_a", "column_b"</a> }; var rows = DB.execute(sql); DB Select - All Columns var sql = { action: "select", table: "my_table" }; var rows = DB.execute(sql); Simple DB Insert var sql = { action: "insert", table: "my_table", data: { column_a: "value a", column_b: "value b" } }; DB.execute(sql); DB Insert with Return Column var sql = { action: "insert", table: "my_table", data: { column_a: "value a", column_b: "value b" }, returnColumn: "column_c" }; var returnedColumn = DB.execute(sql); Simple DB Delete var sql = { action: "delete", table: "my_table", where: { column_a: "value a", column_b: "value b" } }; DB.execute(sql); Simple DB Upsert var sql = { action: "upsert", table: "my_table", data: { column_a: "value a", column_b: "value b", column_c: "value c", column_d: "value d" }, where: { column_a: "value a", column_b: "value b" } }; DB.execute(sql); Simple DB Query with Parameters var sql = { query: "select column_c, column_d from my_table where a = {{valueA}} and b = {{valueB}}", data: { valueA: "value a", valueB: "value b" } }; var rows = DB.execute(sql); Configuration

Database aliases configured in AddOn settings
Connection pooling
Query timeout settings
Transaction support

SSLCertificateChecker Quick Reference

Check SSL certificate validity and expiration for websites

Key Features

Verify SSL certificate validity
Check certificate expiration dates
Monitor multiple domains
Alert on expiring certificates
Certificate chain validation
Get certificate details (issuer, subject, dates)
Automated certificate monitoring

Server-Side Usage: // Get the SSLCertificateChecker API var SSLChecker = js.getObject("/OpenForum/AddOn/SSLCertificateChecker","SSLCertificateChecker.sjs"); // Check certificate for a domain var certInfo = SSLChecker.checkCertificate("example.com"); // Get certificate expiration date var expiryDate = SSLChecker.getExpirationDate("example.com"); // Check if certificate is expiring soon var isExpiring = SSLChecker.isExpiringSoon("example.com", 30); // 30 days threshold // Get full certificate details var details = SSLChecker.getCertificateDetails("example.com"); Client-Side Usage: // Check certificate JSON.get('/OpenForum/AddOn/SSLCertificateChecker/Check', null, 'domain=example.com') .onSuccess(function(certInfo) { console.log('Certificate info:', certInfo); console.log('Valid until:', certInfo.expirationDate); }).go(); // Check multiple domains JSON.post('/OpenForum/AddOn/SSLCertificateChecker/CheckMultiple', null, 'domains=' JSON.stringify(<a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/SSLCertificateChecker/QuickReference/'example.com', 'example.org'"target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/SSLCertificateChecker/QuickReference/'example.com', 'example.org' does not exist. Click to create it.">'example.com', 'example.org'</a>)) .onSuccess(function(results) { console.log('Certificate checks:', results); }).go(); Certificate Information Returned

Issuer - Certificate authority
Subject - Domain information
Valid from - Start date
Valid until - Expiration date
Days remaining - Time until expiration
Certificate chain - Full chain validation

Configuration

Domain list to monitor
Expiration warning threshold (days)
Check frequency
Email notification settings

Search Quick Reference

Search OpenForum pages, JavaScript files, and raw file content

Key Features

Content search across all pages
JavaScript-specific search
Raw file search
Full-text search capabilities
Search result ranking
Link to search results
Multiple search modes

Server-Side Usage: // Get the Search API var Search = js.getObject("/OpenForum/AddOn/Search","Search.sjs"); // Content search var results = Search.contentSearch("search query"); // JavaScript search var jsResults = Search.jsSearch("function name"); // Raw file search var fileResults = Search.rawSearch("text in files"); // Search with options var results = Search.search("query", { searchType: "content", maxResults: 50, pageName: "/StartPage" }); Client-Side Usage: // Content search JSON.get('/OpenForum/AddOn/Search/Content', null, 'query=' encodeURIComponent('search terms')) .onSuccess(function(results) { console.log('Search results:', results); }).go(); // JavaScript search JSON.get('/OpenForum/AddOn/Search/JS', null, 'query=' encodeURIComponent('function name')) .onSuccess(function(results) { console.log('JS search results:', results); }).go(); // File search JSON.get('/OpenForum/AddOn/Search/Raw', null, 'query=' encodeURIComponent('file content')) .onSuccess(function(results) { console.log('File results:', results); }).go(); Search Types

Content Search - Searches page content and rendered text
JS Search - Searches JavaScript files (.js, .sjs)
File Search - Searches raw file content across all attachments

Result Format { title: "Page Title", link: "/PageName", snippet: "...matching text...", score: 0.95 } Configuration

Search index settings
Maximum results per query
Search scope (specific pages or entire wiki)
File type filters

ServerClient Quick Reference

HTTP client for server-side requests to external APIs and services

Key Features

Make HTTP requests from server-side JavaScript
Support for GET, POST, PUT, DELETE methods
Custom headers and authentication
Handle JSON, XML, and plain text responses
Connection timeout configuration
SSL/TLS support
Response streaming

Server-Side Usage: // Get the ServerClient API var ServerClient = js.getObject("/OpenForum/AddOn/ServerClient","ServerClient.sjs"); // Simple GET request var response = ServerClient.get("https://api.example.com/data"); // GET with headers var response = ServerClient.get("https://api.example.com/data", { "Authorization": "Bearer token123", "Accept": "application/json" }); // POST request with JSON data var response = ServerClient.post( "https://api.example.com/data", JSON.stringify({key: "value"}), {"Content-Type": "application/json"} ); // PUT request var response = ServerClient.put( "https://api.example.com/data/123", JSON.stringify({key: "updated value"}), {"Content-Type": "application/json"} ); // DELETE request var response = ServerClient.delete("https://api.example.com/data/123"); // Parse JSON response var jsonData = JSON.parse(response); Response Object { statusCode: 200, body: "response content", headers: { "content-type": "application/json" } } Configuration

Connection timeout (milliseconds)
Read timeout (milliseconds)
SSL certificate validation
Proxy settings
Default headers

ServiceBuilder Quick Reference

Build and deploy OpenForum services, JavaScript libraries, Extensions, Plugins, and Progressive Web Apps

Key Features

Service Builder - Create OpenForum services with API endpoints
Javascript Builder - Build and minify JavaScript libraries
Extension Builder - Create OpenForum markup extensions
Plugin Builder - Build server-side plugins
Progressive Web App Builder - Generate PWA manifests and service workers
Code generation and scaffolding
Automated build processes

Server-Side Usage: // Get the ServiceBuilder API var ServiceBuilder = js.getObject("/OpenForum/AddOn/ServiceBuilder","ServiceBuilder.sjs"); // Build a service ServiceBuilder.buildService("/MyPage", { serviceName: "MyService", endpoints: <a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/ServiceBuilder/QuickReference/"getData", "postData""target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/ServiceBuilder/QuickReference/"getData", "postData" does not exist. Click to create it.">"getData", "postData"</a> }); // Build JavaScript library ServiceBuilder.buildJavascript("/MyPage", { sourceFiles: <a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/ServiceBuilder/QuickReference/"file1.js", "file2.js""target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/ServiceBuilder/QuickReference/"file1.js", "file2.js" does not exist. Click to create it.">"file1.js", "file2.js"</a>, outputFile: "library.min.js", minify: true }); // Generate Extension ServiceBuilder.buildExtension("/MyPage", { extensionName: "MyExtension", parameters: <a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/ServiceBuilder/QuickReference/"param1", "param2""target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/ServiceBuilder/QuickReference/"param1", "param2" does not exist. Click to create it.">"param1", "param2"</a> }); // Build Progressive Web App ServiceBuilder.buildPWA("/MyPage", { appName: "My App", description: "App description", icons: <img src="/OpenForum/Editor?pageName=/OpenForum/AddOn/ServiceBuilder/QuickReference/"icon-192.png", "icon-512.png"" alt=""icon-192.png", "icon-512.png"" title=""icon-192.png", "icon-512.png""/> }); Client-Side Usage: // Build service via API JSON.post('/OpenForum/AddOn/ServiceBuilder/Build', null, 'pageName=/MyPage&type=service&config=' JSON.stringify(config)) .onSuccess(function(result) { console.log('Service built:', result); }).go(); // Generate PWA manifest JSON.post('/OpenForum/AddOn/ServiceBuilder/PWA', null, 'pageName=/MyPage&appName=MyApp') .onSuccess(function(result) { console.log('PWA created:', result); }).go(); Builder Types

Service Builder - API endpoints and server-side services
Javascript Builder - Bundled and minified JavaScript
Extension Builder - OpenForum markup extensions
Plugin Builder - Server-side Java plugins
PWA Builder - Progressive Web App configuration

Configuration

Build output locations
Minification settings
Dependency management
Service definitions

SiteMapBuilder Quick Reference

Generate XML sitemaps for search engine optimization

Key Features

Generate sitemap.xml files
Automatic page discovery
Configurable page priorities
Change frequency settings
Last modified timestamps
Support for multiple sitemaps
Search engine submission

Server-Side Usage: // Get the SiteMapBuilder API var SiteMapBuilder = js.getObject("/OpenForum/AddOn/SiteMapBuilder","SiteMapBuilder.sjs"); // Generate sitemap for entire wiki SiteMapBuilder.generateSitemap("/"); // Generate sitemap for specific page tree SiteMapBuilder.generateSitemap("/MySection"); // Generate with options SiteMapBuilder.generateSitemap("/", { outputFile: "sitemap.xml", baseUrl: "https://example.com", defaultPriority: 0.5, defaultChangeFreq: "weekly" }); // Add page to sitemap SiteMapBuilder.addPage("/MyPage", { priority: 0.8, changefreq: "daily" }); Client-Side Usage: // Generate sitemap JSON.post('/OpenForum/AddOn/SiteMapBuilder/Generate', null, 'pageName=/&baseUrl=' encodeURIComponent('https://example.com')) .onSuccess(function(result) { console.log('Sitemap generated:', result); }).go(); // Get sitemap URL var sitemapUrl = '/sitemap.xml'; Sitemap Format <?xml version="1.0" encoding="UTF-8"?> <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> <url> <loc>https://example.com/PageName</loc> <lastmod>2025-01-15</lastmod> <changefreq>weekly</changefreq> <priority>0.5</priority> </url> </urlset> Change Frequency Options

always
hourly
daily
weekly
monthly
yearly
never

Configuration

Base URL for absolute links
Default priority (0.0 to 1.0)
Default change frequency
Pages to exclude from sitemap
Output file location

Spider Quick Reference

Web crawler for discovering and indexing pages and links

Key Features

Crawl websites and discover links
Index page content
Follow links automatically
Configurable crawl depth
URL filtering and exclusions
Crawl rate limiting
Queue-based crawling
Real-time crawl monitoring

Server-Side Usage: // Get the Spider API var Spider = js.getObject("/OpenForum/AddOn/Spider","Spider.sjs"); // Start spider crawl Spider.crawl("https://example.com", { maxDepth: 3, maxPages: 100, followExternal: false }); // Stop spider Spider.stop(); // Get crawl status var status = Spider.getStatus(); // Get discovered URLs var urls = Spider.getDiscoveredURLs(); // Configure spider Spider.configure({ maxDepth: 5, maxPages: 500, delay: 1000, // milliseconds between requests userAgent: "OpenForum Spider" }); Client-Side Usage: // Start spider JSON.post('/OpenForum/AddOn/Spider/Start', null, 'url=' encodeURIComponent('https://example.com') '&maxDepth=3&maxPages=100') .onSuccess(function(result) { console.log('Spider started:', result); }).go(); // Stop spider JSON.post('/OpenForum/AddOn/Spider/Stop') .onSuccess(function(result) { console.log('Spider stopped'); }).go(); // Get status JSON.get('/OpenForum/AddOn/Spider/Status') .onSuccess(function(status) { console.log('Crawl progress:', status); }).go(); Configuration Options

maxDepth - Maximum link depth to follow
maxPages - Maximum number of pages to crawl
delay - Delay between requests (milliseconds)
followExternal - Follow external links (true/false)
userAgent - User agent string
excludePatterns - URL patterns to exclude
includePatterns - URL patterns to include only

Status Information

Pages crawled
Queue size
Current URL
Discovered links
Errors encountered

Configuration

Starting URL
Crawl depth limits
Rate limiting
URL filters and exclusions

Tagging Quick Reference

Tag and categorize OpenForum pages for better organization and discovery

Key Features

Add tags to pages
List all tags
Find pages by tag
Tag cloud generation
Remove tags from pages
Tag management interface
Search by multiple tags

Server-Side Usage: // Get the Tagging API var Tagging = js.getObject("/OpenForum/AddOn/Tagging","Tagging.sjs"); // Add tag to page Tagging.addTag("/MyPage", "tutorial"); // Add multiple tags Tagging.addTags("/MyPage", <a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/Tagging/QuickReference/"tutorial", "beginner", "javascript""target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/Tagging/QuickReference/"tutorial", "beginner", "javascript" does not exist. Click to create it.">"tutorial", "beginner", "javascript"</a>); // Remove tag from page Tagging.removeTag("/MyPage", "tutorial"); // Get all tags for a page var tags = Tagging.getTags("/MyPage"); // Find pages with tag var pages = Tagging.findPagesWithTag("tutorial"); // Get all tags in system var allTags = Tagging.getAllTags(); // Get tag cloud (tags with counts) var tagCloud = Tagging.getTagCloud(); Client-Side Usage: // Add tag to page JSON.post('/OpenForum/AddOn/Tagging/Add', null, 'pageName=/MyPage&tag=tutorial') .onSuccess(function(result) { console.log('Tag added'); }).go(); // Get tags for page JSON.get('/OpenForum/AddOn/Tagging/Get', null, 'pageName=/MyPage') .onSuccess(function(tags) { console.log('Tags:', tags); }).go(); // Find pages by tag JSON.get('/OpenForum/AddOn/Tagging/Find', null, 'tag=tutorial') .onSuccess(function(pages) { console.log('Pages with tag:', pages); }).go(); // Get tag cloud JSON.get('/OpenForum/AddOn/Tagging/Cloud') .onSuccess(function(tagCloud) { console.log('Tag cloud:', tagCloud); }).go(); Tag Cloud Format <a href=" {tag: "tutorial", count: 15}, {tag: "javascript", count: 12}, {tag: "beginner", count: 8} " target="external_page"> {tag: "tutorial", count: 15}, {tag: "javascript", count: 12}, {tag: "beginner", count: 8} </a> Configuration

Tag storage location
Maximum tags per page
Tag naming conventions
Tag search options

TeleWebOmatic Quick Reference

Remote web interaction and demonstration tool with cursor tracking

Key Features

Remote web page interaction
Cursor position tracking and sharing
Live demonstration capability
Multi-user cursor display
Real-time collaboration
Screen sharing functionality
Remote presentation tool

Server-Side Usage: // Get the TeleWebOmatic API var TeleWebOmatic = js.getObject("/OpenForum/AddOn/TeleWebOmatic","TeleWebOmatic.sjs"); // Start session TeleWebOmatic.startSession("sessionId"); // Track cursor position TeleWebOmatic.updateCursor("sessionId", {x: 100, y: 200}); // Get active cursors var cursors = TeleWebOmatic.getCursors("sessionId"); // Stop session TeleWebOmatic.stopSession("sessionId"); Client-Side Usage: // Join session JSON.post('/OpenForum/AddOn/TeleWebOmatic/Join', null, 'sessionId=session123') .onSuccess(function(result) { console.log('Session joined:', result); }).go(); // Send cursor position JSON.post('/OpenForum/AddOn/TeleWebOmatic/Cursor', null, 'sessionId=session123&x=100&y=200') .onSuccess(function(result) { console.log('Cursor updated'); }).go(); // Get cursor positions JSON.get('/OpenForum/AddOn/TeleWebOmatic/Cursors', null, 'sessionId=session123') .onSuccess(function(cursors) { console.log('Active cursors:', cursors); }).go(); Configuration

Session timeout
Maximum participants
Cursor update frequency
Display settings

Tester Quick Reference

Unit testing framework for OpenForum with fluent-style interface

Key Features

Fluent-style test API (given/when/then pattern)
Server-side JavaScript unit testing
Test result tracking and reporting
Interactive test runner client
Test assertions and expectations
Detailed failure messages
Test suite organization
Command-line and web-based test execution

Test Pattern Tests follow a three-stage pattern:

given - Set up test data
when - Execute the action/method under test
then - Assert expected output

Server-Side Usage: // Import the test framework var tester = js.getObject("/OpenForum/AddOn/Tester","Test.sjs"); // Create a class to test var MyTestClass = function() { this.increment = function(value) { return value 1; }; this.decrement = function(value) { return value-1; }; }; // Wrap the function under test function testMyClass(fn) { return function (input) { return MyTestClass<a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/Tester/QuickReference/fn"target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/Tester/QuickReference/fn does not exist. Click to create it.">fn</a>(input); }; } // Log message about the test tester.log("Running tests for MyTestClass"); // Create test instance tester.unitTest("Can add one to a number"). given(122). when( testMyClass("increment") ). thenOutputEquals(123). run(); // Another test tester.unitTest("Can subtract one from a number"). given(123). when( testMyClass("decrement") ). thenOutputEquals(122). run(); // Get results var results = tester.getResults(); tester.log("Tests:" results.tests " Passed:" results.passed " Failed:" results.failed); Test Methods

unitTest(name) - Create new test with description
given(data) - Provide input data
when(function) - Specify function to test
thenOutputEquals(expected) - Assert expected output
run() - Execute the test
log(message) - Log a message
getResults() - Get test results summary

Running Tests Via Tester Client: /OpenForum/AddOn/Tester?pageName=/MyPage&testFileName=test.sjs Via URL Action: /OpenForum/AddOn/Tester?action=runTest&pageName=/MyPage&testScript=test.sjs Test Results Format { tests: 2, passed: 1, failed: 1 } Example Test Output Test Results Starting MESSAGE: Started Tester v0.002 The Jester MESSAGE: Running tests for MyTestClass PASSED: Can add one to a number FAILED: Can subtract one from a number. Input (123) Expected (122) but found (124) MESSAGE: Tests:2 Passed:1 Failed:1 Full Reference

TileViewer Quick Reference

Canvas-based tile map viewer and renderer

Key Features

Display tile-based maps
Canvas rendering
Tile set management
Zoom and pan controls
Layer support
Custom tile rendering
Map data loading

Server-Side Usage: // Get the TileViewer API var TileViewer = js.getObject("/OpenForum/AddOn/TileViewer","TileViewer.sjs"); // Save tile map data TileViewer.saveTileMap("/MyPage", "map.json", mapData); // Load tile map var map = TileViewer.loadTileMap("/MyPage", "map.json"); // Save tile set TileViewer.saveTileSet("/MyPage", "tileset.json", tileSetData); Client-Side Usage: // Load tile map JSON.get('/OpenForum/AddOn/TileViewer/LoadMap', null, 'pageName=/MyPage&fileName=map.json') .onSuccess(function(mapData) { console.log('Map loaded:', mapData); renderMap(mapData); }).go(); // Save tile map JSON.post('/OpenForum/AddOn/TileViewer/SaveMap', null, 'pageName=/MyPage&fileName=map.json&data=' JSON.stringify(mapData)) .onSuccess(function(result) { console.log('Map saved'); }).go(); Map Data Format { width: 20, height: 15, tileSize: 32, layers: <a href=" { name: "ground", tiles: <div class="panel callout radius"></div>,1,2,3..." target="external_page"> { name: "ground", tiles: <div class="panel callout radius"></div>,1,2,3...</a>, <a href="/OpenForum/Editor?pageName=/OpenForum/AddOn/TileViewer/QuickReference/1,2,3,4..."target="editor" style="color: red" title="The page /OpenForum/Editor?pageName=/OpenForum/AddOn/TileViewer/QuickReference/1,2,3,4... does not exist. Click to create it.">1,2,3,4...</a>, ...] } ], tileset: "tileset.png" } Configuration

Canvas size
Tile dimensions
Default tile set
Rendering options

Update Quick Reference

Automatic update system for OpenForum pages and AddOns from parent servers

Key Features

Check for available updates
Download and install updates
Version tracking
Dependency management
Automatic update capability
Release notes display
Update history tracking
Parent server synchronization

Server-Side Usage: // Get the Update API var Update = js.getObject("/OpenForum/AddOn/Update","Update.sjs"); // Check for updates var updateInfo = Update.getUpdateInfo("/MyPage"); // Get update from parent server Update.getUpdate("/MyPage"); // List available updates var updates = Update.listAvailableUpdates(); // Install update Update.installUpdate("/MyPage", "1.2.0"); // Check if update available var isAvailable = Update.isUpdateAvailable("/MyPage"); Client-Side Usage: // Get update info JSON.get('/OpenForum/AddOn/Update/Info', null, 'pageName=/MyPage') .onSuccess(function(info) { console.log('Update info:', info); console.log('Version:', info.version); console.log('Release notes:', info.notes); }).go(); // Download and install update JSON.post('/OpenForum/AddOn/Update/Get', null, 'pageName=/MyPage') .onSuccess(function(result) { console.log('Update installed:', result); }).go(); // List all available updates JSON.get('/OpenForum/AddOn/Update/List') .onSuccess(function(updates) { console.log('Available updates:', updates); }).go(); Update Info Format { pagename: "/MyPage", version: "1.2.0", releaseTime: "2025-01-15", zipfilesize: 52341, extra: { notes: "Bug fixes and improvements", requires: <a href=" {pageName: "/OpenForum/Core", version: "2.0"} " target="external_page"> {pageName: "/OpenForum/Core", version: "2.0"} </a> }, autoUpdate: true } Configuration

Parent host URL
Auto-update settings
Update check frequency
Dependency resolution

UserFeedback Quick Reference

Collect user feedback with simple thumbs up/down buttons

Key Features

Add feedback buttons to any page
Thumbs up/down voting
Track feedback responses
Customizable prompt text
Anonymous feedback collection
Feedback analytics and reporting
Export feedback data

Extension Usage: // Add feedback buttons to a page <script> var pageLikes = {likes: "", dislikes: ""}; OpenForum.includeScript("/OpenForum/AddOn/UserFeedback/UserFeedbackClient.js"); OpenForum.includeScript("/OpenForum/AddOn/UserFeedback/user-feedback.js"); </script> <span id="userFeedback" style="display: none;"> Was this helpful? <a href="#" onclick="UserFeedback.thumbsUp();"><img src="/OpenForum/AddOn/UserFeedback/thumb-up.png" width="32" height="32"/></a> {{pageLikes.likes}} <a href="#" onclick="UserFeedback.thumbsDown();"><img src="/OpenForum/AddOn/UserFeedback/thumb-down.png" width="32" height="32"/> </a> {{pageLikes.dislikes}} <a style="font-size: 10px; border-radius: 5px; margin: 0px; padding: 5px; background-color: #2ba6cb; border-color: #2285a2; color: #ffffff;" onClick="UserFeedback.showSendFeedback('text');">Send Feedback</a> </span> <div id="userFeedbackModal" class="reveal-modal" data-reveal aria-labelledby="firstModalTitle" aria-hidden="true" role="dialog"> <h2>Send Feedback {{UserFeedback.icon}}</h2> <p><textarea of-id="UserFeedback.text" cols="120" rows="3" maxlength="250"></textarea></p> <p>Please contact me at email address <input type="text" of-id="UserFeedback.email"/></p> <p><a href="#" onClick="UserFeedback.sendFeedback();return false;" class="success button">Send Feedback</a></p> <a class="close-reveal-modal" aria-label="Close">×</a> </div> // Without text <script> var pageLikes = {likes: "", dislikes: ""}; OpenForum.includeScript("/OpenForum/AddOn/UserFeedback/UserFeedbackClient.js"); OpenForum.includeScript("/OpenForum/AddOn/UserFeedback/user-feedback.js"); </script> <span id="userFeedback" style="display: none;"> Did you find this page helpful? <a href="#" onclick="UserFeedback.thumbsUp();"><img src="/OpenForum/AddOn/UserFeedback/thumb-up.png" width="32" height="32"/></a> {{pageLikes.likes}} <a href="#" onclick="UserFeedback.thumbsDown();"><img src="/OpenForum/AddOn/UserFeedback/thumb-down.png" width="32" height="32"/> </a> {{pageLikes.dislikes}} <a style="font-size: 10px; border-radius: 5px; margin: 0px; padding: 5px; background-color: #2ba6cb; border-color: #2285a2; color: #ffffff;" onClick="UserFeedback.showSendFeedback('text');">Send Feedback</a> </span> <div id="userFeedbackModal" class="reveal-modal" data-reveal aria-labelledby="firstModalTitle" aria-hidden="true" role="dialog"> <h2>Send Feedback {{UserFeedback.icon}}</h2> <p><textarea of-id="UserFeedback.text" cols="120" rows="3" maxlength="250"></textarea></p> <p>Please contact me at email address <input type="text" of-id="UserFeedback.email"/></p> <p><a href="#" onClick="UserFeedback.sendFeedback();return false;" class="success button">Send Feedback</a></p> <a class="close-reveal-modal" aria-label="Close">×</a> </div> Parameters

text - Optional text to display before the buttons

Server-Side Usage: // Get the UserFeedback API var UserFeedback = js.getObject("/OpenForum/AddOn/UserFeedback","UserFeedback.sjs"); // Record feedback UserFeedback.recordFeedback("/MyPage", true); // true = positive, false = negative // Get feedback for page var feedback = UserFeedback.getFeedback("/MyPage"); // Get feedback statistics var stats = UserFeedback.getStatistics("/MyPage"); Client-Side Usage: // Record feedback JSON.post('/OpenForum/AddOn/UserFeedback/Record', null, 'pageName=/MyPage&positive=true') .onSuccess(function(result) { console.log('Feedback recorded'); }).go(); // Get feedback stats JSON.get('/OpenForum/AddOn/UserFeedback/Stats', null, 'pageName=/MyPage') .onSuccess(function(stats) { console.log('Positive:', stats.positive); console.log('Negative:', stats.negative); }).go(); Feedback Statistics Format { pageName: "/MyPage", positive: 25, negative: 3, total: 28, score: 0.89 } Configuration

Feedback button text
Anonymous or authenticated voting
Feedback storage location

VirtualAssistant Quick Reference

Voice-controlled interface for interacting with OpenForum using speech commands

Key Features

Voice command recognition
Speech-to-text input
Text-to-speech output
Interactive chat interface
Canvas-based visual feedback
Configurable voice commands
Virtual Assistant Editor for configuration
Custom command handlers

Server-Side Usage: // Get the VirtualAssistant API var VirtualAssistant = js.getObject("/OpenForum/AddOn/VirtualAssistant","VirtualAssistant.sjs"); // Process voice command var response = VirtualAssistant.processCommand("open page home"); // Configure voice commands VirtualAssistant.configure({ name: "Assistant Name", commands: <a href=" {trigger: "open page", action: "navigateTo"} " target="external_page"> {trigger: "open page", action: "navigateTo"} </a> }); // Add custom command handler VirtualAssistant.addCommand("open page", function(pageName) { return {action: "navigate", target: pageName}; }); // Get command history var history = VirtualAssistant.getHistory(); Client-Side Usage: // Send voice command JSON.post('/OpenForum/AddOn/VirtualAssistant/Command', null, 'command=' encodeURIComponent('open page home')) .onSuccess(function(response) { console.log('Command response:', response); }).go(); // Load voice configuration JSON.get('/OpenForum/AddOn/VirtualAssistant/Config') .onSuccess(function(config) { console.log('Voice config:', config); }).go(); // Get command history JSON.get('/OpenForum/AddOn/VirtualAssistant/History') .onSuccess(function(history) { console.log('Commands:', history); }).go(); Configuration File (config.json) { "name": "Virtual Assistant", "greeting": "Voice interface ready", "commands": <a href=" {"pattern": "open page *", "action": "navigate"}, {"pattern": "search for *", "action": "search"} " target="external_page"> {"pattern": "open page *", "action": "navigate"}, {"pattern": "search for *", "action": "search"} </a> } Configuration

Voice command patterns
Command handlers and actions
Speech recognition settings
Visual feedback options
Command history retention

VirtualAssistantEditor Quick Reference

Visual editor for configuring VirtualAssistant voice commands and settings

Key Features

Visual configuration interface
Edit voice command patterns
Configure command handlers
Tabbed editing interface
Command testing and validation
Save and load configurations
Quick command access

Server-Side Usage: // Get the VirtualAssistantEditor API var VAEditor = js.getObject("/OpenForum/AddOn/VirtualAssistantEditor","VirtualAssistantEditor.sjs"); // Load configuration for editing var config = VAEditor.loadConfig("/MyAssistant"); // Save configuration VAEditor.saveConfig("/MyAssistant", configData); // Validate configuration var isValid = VAEditor.validateConfig(configData); Client-Side Usage: // Load configuration JSON.get('/OpenForum/AddOn/VirtualAssistantEditor/Load', null, 'pageName=/MyAssistant') .onSuccess(function(config) { console.log('Config loaded:', config); }).go(); // Save configuration JSON.post('/OpenForum/AddOn/VirtualAssistantEditor/Save', null, 'pageName=/MyAssistant&config=' JSON.stringify(configData)) .onSuccess(function(result) { console.log('Config saved'); }).go(); Configuration

Voice command patterns
Command actions and handlers
Assistant settings
UI customization

WhoIs Quick Reference

Domain WHOIS lookup and DNS record information tool

Key Features

WHOIS domain registration lookup
Domain expiry date checking
DNS record lookup (A, MX, AAAA, CNAME, TXT, NS)
Registrar information
Registration status
Name server details
Raw WHOIS data access

Server-Side Usage: // Get the WhoIs API var WhoIs = js.getObject("/OpenForum/AddOn/WhoIs","WhoIs.sjs"); // Look up domain WHOIS information var record = WhoIs.lookup("example.com"); // Get DNS records var dnsRecords = WhoIs.getDNSRecords("example.com"); // Check domain expiry var expiryDate = WhoIs.getExpiryDate("example.com"); Client-Side Usage: // Look up domain JSON.post('/OpenForum/AddOn/WhoIs/Lookup', null, 'domainName=example.com') .onSuccess(function(record) { console.log('Domain:', record.domainName); console.log('Registrar:', record.registrar); console.log('Expiry:', record.expiryDate); console.log('A records:', record.nslookup.a); }).go(); // Get WHOIS info JSON.get('/OpenForum/AddOn/WhoIs/Check', null, 'domain=example.com') .onSuccess(function(info) { console.log('WHOIS info:', info); }).go(); WHOIS Record Format { domainName: "example.com", lastUpdated: "2025-01-10", registeredOn: "2020-01-15", expiryDate: "2026-01-15", registrar: "Example Registrar Inc.", registrationStatus: "active", nslookup: { a: undefined, mx: undefined, aaaa: undefined, cname: <a href="/OpenForum/AddOn/WhoIs/QuickReference/" target="newTab"><img src='/OpenForum/Images/icons/png/link_go.png' /></a>, txt: undefined, ns: undefined } } DNS Record Types

A - IPv4 address records
MX - Mail exchange records
AAAA - IPv6 address records
CNAME - Canonical name records
TXT - Text records (SPF, DKIM, etc.)
NS - Name server records

Configuration

WHOIS server settings
Timeout configuration
DNS resolver settings

WorkQueue Quick Reference

Manage and process work items in sequential queues with SLA tracking

Key Features

Create and manage multiple work queues
Add items to queues
Process items sequentially
Track item status (pending, processing, completed, failed)
SLA time monitoring
Queue administration interface
Item metadata and timestamps
Queue statistics and monitoring

Server-Side Usage: // Get the WorkQueue API var WorkQueue = js.getObject("/OpenForum/AddOn/WorkQueue","WorkQueue.sjs"); // Create a queue WorkQueue.createQueue("myQueue"); // Add item to queue WorkQueue.addItem("myQueue", { name: "task1", data: {key: "value"}, slaTime: 3600000 // 1 hour in milliseconds }); // Get next item from queue var item = WorkQueue.getNextItem("myQueue"); // Update item status WorkQueue.updateStatus("myQueue", "task1", "processing"); // Complete item WorkQueue.completeItem("myQueue", "task1"); // Fail item WorkQueue.failItem("myQueue", "task1", "Error message"); // Get queue statistics var stats = WorkQueue.getQueueStats("myQueue"); // List all queues var queues = WorkQueue.listQueues(); Client-Side Usage: // Add item to queue JSON.post('/OpenForum/AddOn/WorkQueue/Add', null, 'queueName=myQueue&itemName=task1&data=' JSON.stringify(itemData)) .onSuccess(function(result) { console.log('Item added to queue'); }).go(); // Get next item JSON.get('/OpenForum/AddOn/WorkQueue/Next', null, 'queueName=myQueue') .onSuccess(function(item) { console.log('Next item:', item); }).go(); // Update item status JSON.post('/OpenForum/AddOn/WorkQueue/UpdateStatus', null, 'queueName=myQueue&itemName=task1&status=processing') .onSuccess(function(result) { console.log('Status updated'); }).go(); // Get queue stats JSON.get('/OpenForum/AddOn/WorkQueue/Stats', null, 'queueName=myQueue') .onSuccess(function(stats) { console.log('Queue count:', stats.count); }).go(); Item Statuses

pending - Item waiting to be processed
processing - Item currently being processed
completed - Item successfully processed
failed - Item processing failed

Queue Item Format { name: "task1", status: "pending", sla_time: 3600000, created: 1705334400000, data: { // Custom item data } } Configuration

Queue retention policy
SLA warning thresholds
Auto-retry failed items
Queue processing workers

OpenForum Add Ons