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

Content Editor - Quick Reference

The content editor is a two panel editor. It is intended for pages that just contain text and images rather than those that are part of a web application.

Editor Panels

The two panels can be resized by dragging the separator between them.

The left hand panel gives an over view of the page being edited at the top, a list of pages to edit in the middle and a view of the image library at the bottom.

The right hand panel gives a view of the page content for editing. At the top is the title as shown on the browser tab and below are the sections of the page.

Adding Blocks

Above and below each page section are + buttons that will add content either above or below existing elements of content. There are also up and down buttons to move the content up and down the sections in the page.

On clicking + you are presented with a list of blocks that can be added to the page.

For simple formatted text and images, the WYSIWYG block allows you to enter text and type set it adding text styles, links and lists etc.

Images

To add an image into the WYSIWYG panel, find the image in the image library in the left hand pane or select to upload one. Drag the image into the WYSIWYG content block. Click on it to set any alternative text or its placement in the text.

A number of other block types are available that add either configurable page elements or page layouts.

Preview and Publish

To see how your page will look once published, click on Preview at the top of the left hand pane. This will save the page to a space for unpublished pages and make the page visible in another browser tab. Saving the page once the preview has been opened will automatically update the preview tab.

Once you are happy with your page, click Publish and the page will be published to the live area of your website.

New Pages

To create a new page select Create A New Page. In the popup window, enter the new pages title and optionally select a category. Select Create New Page and a new page will be added to the list and the editor for the page opened.

API Reference

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

Mailer Quick Reference

Notes

Menu Editor - Quick Reference

A menu bar editor.

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.

Released Packages - Quick Reference

The Release AddOn enables the releaseing of packages for use on other sites.

Special files

pre-release.sjs - This script is run on the releasing server before the release package is built
release-excludes-files.json - A list of files to exclude from the release. This can include regex like .*-test.js
release-info.json - Contains release information
install.sjs - Run on the server where the package is installed after the package has been installed

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

QuickReference

Server Side

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

Create a 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 );

Create a DB Select that returns all columns

var sql = { action: "select", table: "my_table" }; var rows = DB.execute( SQL );

Create a Simple DB Insert

var sql = { action: "insert", table: "my_table", data: { column_a: "value a", column_b: "value b" } }; DB.execute( SQL );

Create a Simple DB Insert that returns a 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 );

Create a Simple DB Delete

var sql = { action: "delete", table: "my_table", where: { column_a: "value a", column_b: "value b" } }; DB.execute( SQL );

Create a 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 );

Create a Simple DB Query

var sql = { query: "select column_c, column_d from my_table where a = { {valueA} } and b = { {valueB} } data: { valueA: "value a", valueB: "value b" } }; DB.execute( SQL );

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

/OpenForum/AddOn/Update Sevice API Version 0.1.9

Get Actions

Action getUpdate

Parameters

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

Example Get Request

/OpenForum/AddOn/Update?action=getUpdate

Example Response

Example Error Response

Action getUpdateInfo

Parameters

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

Example Get Request

/OpenForum/AddOn/Update?action=getUpdateInfo

Example Response

Example Error Response

Action getReleases

Parameters

Name	Description

Example Get Request

/OpenForum/AddOn/Update?action=getReleases

Example Response

Example Error Response

Post Actions

Action upsertToJSONList

Parameters

Name	Description
row (required=true)	{{parameter.description}}
indexName (required=true)	{{parameter.description}}
pageName (required=true)	{{parameter.description}}
fileName (required=true)	{{parameter.description}}

Example Post Request

/OpenForum/AddOn/Update?action=upsertToJSONList

OpenForum Add Ons

ActionLog

Alert

ContentEditor

DataLogger

Developer

ImageProcessor

Mailer

Notes

MenuEditor

Publisher

ReleasedPackages

RemoteAdministration

RemoteLogger

SQL

ServiceBuilder

Tagging

Update