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

/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

QuickReference

Anonymous Session provides the ability to offer tokens to store assets against like Zoom call ids. You can also combine them with passwords as an extra security step.

Example Use

/OpenForum/AddOn/AnonymousSession?action=validateSession&key=3ACDC2D4

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; });

Claude MCP Tools Quick Reference

Comprehensive guide to MCP tools, prompts, and resources for OpenForum integration

This reference provides detailed documentation for all available MCP (Model Context Protocol) tools, prompts, and resources in the HomeLab Claude environment. Each tool includes descriptions, parameters, usage examples, and integration patterns for seamless OpenForum development.

ClaudeTool

CLASSIFICATION: System Control Interface

FUNCTION: Initiate Claude Desktop restart sequence to reload MCP configurations

DESCRIPTION: This tool provides programmatic control over the Claude Desktop application lifecycle. When invoked, it triggers a clean restart of the Claude Desktop environment, which forces a reload of all MCP tool definitions, prompts, and resources from their registry files. This is essential after creating new tools, modifying existing ones, or updating configuration files like tool-list.json. The optional prompt parameter allows you to request user confirmation before the restart occurs.

ACCESS PROTOCOL: Request "restart" or "reload MCP tools" via voice command

PARAMETERS:

prompt (boolean) - Enable confirmation dialog before system restart

restart Claude Desktop

restart with confirmation prompt

MCPDevTool

CLASSIFICATION: Development Environment

FUNCTION: Create, test, and deploy new MCP tools within the system matrix

DESCRIPTION: A comprehensive development toolkit for building and managing MCP tools in the OpenForum environment. This meta-tool streamlines the entire development lifecycle by providing commands to create new tool files from templates, validate JavaScript syntax, register tools in the tool-list.json registry, and browse the tool directory structure. It eliminates manual file manipulation and reduces errors by automating the deployment process. The tool also provides direct access to read existing tool source code and restart Claude Desktop to test newly created or modified tools.

ACCESS PROTOCOL: Development workflow for MCP tool creation

AVAILABLE OPERATIONS:

create - Instantiate new tool from source code
test - Execute syntax validation protocols
deploy - Integration with tool-list.json registry
list - Display all available system tools
read - Access tool source code
restart - Reload Claude Desktop matrix
template - Retrieve tool construction template
listfiles - Browse directory matrix structures

create a new MCP tool for file processing

test the syntax of MyNewTool

deploy the DatabaseTool to the tool list

JavaTool

CLASSIFICATION: Code Compilation Matrix

FUNCTION: Compile and execute Java code, run Maven build protocols

DESCRIPTION: A full-featured Java development environment that bridges Claude AI with Java compilation and execution capabilities. This tool handles both standalone Java file compilation using javac and comprehensive Maven project management including building, testing, packaging, and executing Java applications. It manages classpaths, working directories, and command-line arguments automatically. Perfect for rapid prototyping, testing Java snippets, running Maven builds, executing test suites, and creating new Maven projects with specified group and artifact IDs. The tool captures both standard output and error streams to provide complete feedback on compilation and execution results.

ACCESS PROTOCOL: Java development and testing environment

AVAILABLE OPERATIONS:

compile_java - Compile .java source files
run_java - Execute compiled Java classes
compile_and_run - Combined compilation and execution
maven_compile - Maven compilation phase
maven_test - Execute Maven test suite
maven_package - Generate Maven package
maven_clean - Clean Maven project artifacts
maven_exec - Execute Java main class
create_maven_project - Initialize new Maven project

compile and run my HelloWorld.java file

run Maven tests on my project

Structured conversation initiators with expert guidance protocols for specific domains.

MCP Tool Developer

CLASSIFICATION: Development Assistant Protocol

FUNCTION: Expert guidance for MCP tool development

DESCRIPTION: An AI-powered expert assistant prompt that provides specialized guidance throughout the MCP tool development process. When activated, Claude assumes the role of an experienced MCP developer who can help design tool architectures, write clean JavaScript code for OpenForum integration, debug issues, suggest best practices, and explain MCP protocol specifications. This prompt is particularly valuable for understanding the nuances of tool parameter definitions, error handling patterns, and OpenForum helper class usage.

ACCESS PROTOCOL: "Use the MCP tool developer prompt to help me..."

PARAMETERS:

tool_type (optional) - Specify tool category
complexity (optional) - Define complexity level
specific_help (optional) - Target assistance area

use the MCP tool developer prompt to create a file processor

Java Code Reviewer

CLASSIFICATION: Code Analysis Protocol

FUNCTION: Expert Java code review and optimization recommendations

DESCRIPTION: A specialized code review prompt that transforms Claude into an expert Java code reviewer with deep knowledge of best practices, design patterns, performance optimization, and common pitfalls. When invoked, this prompt enables comprehensive analysis of Java code including style consistency, potential bugs, security vulnerabilities, performance bottlenecks, and architectural improvements. It can focus on specific aspects like thread safety, memory management, or Java version-specific features based on your requirements.

ACCESS PROTOCOL: "Use the Java code reviewer prompt to..."

PARAMETERS:

review_focus (optional) - Specify review focus area
code_complexity (optional) - Define code complexity level
java_version (optional) - Target Java version

use the Java code reviewer prompt for performance review

Data source access points, file systems, and system information repositories.

Tool Directory

URI: openforum://HomeLab/Claude/tools

CLASSIFICATION: File System Browser

FUNCTION: Browse MCP tool files and configuration matrices

DESCRIPTION: A dynamic resource that provides real-time inventory of all MCP tools in the system. When accessed, it scans the HomeLab/Claude directory for .sjs tool files, cross-references them with tool-list.json, and returns detailed metadata including file sizes, modification dates, registration status, and tool descriptions. This resource is invaluable for system auditing, discovering available tools, and identifying orphaned or unregistered tools that may need attention.

DATA FORMAT: JSON metadata with tool information, file statistics, and registry status

show me what MCP tools are available

System Logs

URI: openforum://system/logs

CLASSIFICATION: System Monitoring Interface

FUNCTION: Access system logs and MCP interaction history

DESCRIPTION: A comprehensive logging resource that aggregates system events, MCP tool invocations, error messages, and server activity into a readable format. It provides insight into what tools have been called, when they were executed, what errors occurred, and overall system health. Essential for troubleshooting tool failures, monitoring system performance, and understanding the flow of MCP communications between Claude and the OpenForum server.

DATA FORMAT: Server status reports, recent events, error summaries

check the system logs for any errors

Project Files

URI: openforum://projects/files

CLASSIFICATION: Project Analysis System

FUNCTION: Browse and analyze project files across development workspace

DESCRIPTION: A workspace analysis resource that scans configured project directories and generates comprehensive summaries including file counts, directory structures, programming language distributions, and project statistics. It helps Claude understand your project landscape without manually exploring the filesystem. Useful for project overviews, identifying codebases to work with, and getting quick insights into project composition and organization.

DATA FORMAT: Project summaries, file statistics, directory structures

show me what projects are available

Tool Development Workflow

create a new MCP tool for database queries

test the syntax of my DatabaseTool

add DatabaseTool to the tool list

restart Claude Desktop to load new tools

Java Development Workflow

Write Java code in your development environment
Execute: "compile my Java project"
Execute: "run Maven tests"
Use Java code reviewer prompt for guidance

System Monitoring Protocol

read the tool directory resource

check system logs for errors

list all available MCP tools

tool-list.json

CLASSIFICATION: Tool Registry Database

FUNCTION: Defines available MCP tools in the system matrix

{
  "toolName": {
    "pageName": "/HomeLab/Claude",
    "fileName": "ToolName.sjs"
  }
}

prompt-list.json

CLASSIFICATION: Prompt Registry Database

FUNCTION: Defines available MCP prompts in the system

{
  "promptName": {
    "pageName": "/HomeLab/Claude", 
    "fileName": "PromptName.sjs"
  }
}

resource-list.json

CLASSIFICATION: Resource Registry Database

FUNCTION: Defines available MCP resources in the system

{
  "resourceName": {
    "pageName": "/HomeLab/Claude",
    "fileName": "ResourceName.sjs"
  }
}

MCP Protocol

VERSION: 2024-11-05
TRANSPORT: OpenForum JavaScript server
CAPABILITIES: tools, prompts, resources (all with listChanged: true)

File System Locations

SERVER ROOT: /web/content/default/HomeLab/Claude/
TOOLS: *.sjs files + tool-list.json
PROMPTS: *Prompt.sjs files + prompt-list.json
RESOURCES: *Resource.sjs files + resource-list.json

OpenForum Integration

FILE HELPER: file.getFileAsString(), file.saveStringToFile()
JAVASCRIPT HELPER: js.getObject() for dynamic loading
PROCESS HELPER: Execute system commands
SERVER ROOT: All paths relative to /web/content/

Common System Errors

TOOL NOT FOUND: Verify tool-list.json and restart Claude Desktop

SYNTAX ERRORS: Use MCPDevTool test action to validate code

FILE PERMISSIONS: Ensure OpenForum has read/write access

JAVA COMPILATION: Check classpath and file path configurations

Debugging Procedures

LOGS: Read system logs resource for MCP activity analysis
TOOL STATUS: Use MCPDevTool list action for inventory
FILE BROWSER: Use MCPDevTool listfiles action for directory inspection
ERROR FILES: Check for error-*.json files in Claude directory

Tool Development Guidelines

Follow naming conventions (ToolName.sjs)
Include comprehensive error handling
Use OpenForum helper classes
Execute thorough testing before deployment
Document all parameters and usage patterns

Usage Optimization

Be specific in requests ("compile MyClass.java" vs "compile Java")
Use prompts for structured guidance protocols
Check resources for system status monitoring
Restart after configuration changes

Documentation Version: 1.0.0

MCP Server: OpenForum JavaScript Server

Last Updated: Generated dynamically from active tool registry

Support: For issues or questions, consult the MCP Tools Guide

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

Data Transformer - Quick Reference

The data transformer is intended take text from the input and transform it, then place it in the output. No data is shared or sent to our server unless you choose to save it. To do this you will need to have an Electric Llama Company account
To perform a data transformation, you have to do all the hard work, by writing Javascript in the code editor at the bottom of the screen.
The text in the input editor is made available as the variable input and the text in the output can be set by setting the output variable.
A number of useful transformer examples are given below to get you started.
If you have an Electric Llama Company account, you can save any transformers you have written for later use, alternatively each text editor has a download to desktop option.
You can drag and drop files into any of the editors on the transformer page.

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");

The Data Transformer has a few helper functions to make common actions easier.

These functions are provided by an instance of the DataTransformer or DT for short.

Often input data is based on a record per line.

DT.toLines( data, rowSeparator ) converts the data to an array of lines of text.

Returns a string array
If you don't supply data, it defaults to input
If you don't supply rowSeparator, it defaults to new line

DT.linesToString( lines, separator ) converts an array of lines to a string

lines should be an array of strings
If you don't supply separator, it defaults to new line

DT.forEachLine( fn, data) apply a function to each line of text in the data.

Returns an array of strings
If you don't supply data, it defaults to the input

DT.toTable(data, rowSeparator, cellSeparator);

Returns an array of arrays
If you don't supply rowSeparator, it defaults to new line
If you don't supply cellSeparator, it defaults to tab

DT.tableToString(table, rowSeparator, cellSeparator);

table should be an array or arrays
Returns a string
If you don't supply rowSeparator, it defaults to new line
If you don't supply cellSeparator, it defaults to tab

DT.NL the new line character

DT.TAB the tab character

/OpenForum/AddOn/ImageProcessor Sevice API Version 0.1.7

Get Actions

Action updateImages

Parameters

Name	Description

Example Get Request

/OpenForum/AddOn/ImageProcessor?action=updateImages

Example Response

Example Error Response

Action categoriseImages

Parameters

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

Example Get Request

/OpenForum/AddOn/ImageProcessor?action=categoriseImages

Example Response

Example Error Response

Action getImages

Parameters

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

Example Get Request

/OpenForum/AddOn/ImageProcessor?action=getImages

Example Response

Example Error Response

Action getCategories

Parameters

Name	Description

Example Get Request

/OpenForum/AddOn/ImageProcessor?action=getCategories

Example Response

Example Error Response

Post Actions

Action updateImage

Parameters

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

Example Post Request

/OpenForum/AddOn/ImageProcessor?action=updateImage

Example Response

Example Error Response

Mailer Quick Reference

Notes

Menu Editor - Quick Reference

A menu bar editor.

QuickReference

The Publisher AddOn enables the publishing of packages from the developent area of a site into prodction.

All text files in the package (page and sub pages) are translated before publishing. References to Development are removed so a path /MyPage becomes /MyPage

Deletions are not processed immediately, but placed in a deletions script file to run later.

Special files

development-translation.sjs - This is an optional script that will translate the contents of files. The script is passed the contents of each text file as the variable data and is expected to return the transformed version.
publish-config.json - Can contain a list of files to exclude eg.
do-not-release.txt - Marks a page as not to be published. Should contain text stateing the reason
process-deletions.sjs - A script that is generated with files to be deleted after publishing
release-notes.html.fragment - Notes generated during the release are saved here

Generator

Include script: } Function to generate 3 sizes of QR Code }

Scanner

Include script: OpenForum.includeScript("/OpenForum/AddOn/QRCode/Scanner/qr-code-scanner.js"); Create required variables: var qrCodeScanner; var qrcode = { data: "", timeStamp: "", error: true }; Create the scanner and add a listener: OpenForum.init = function() { qrCodeScanner = new QRCodeScanner(); qrCodeScanner.addListener( function( newQR ) { qrcode = newQR; } ); };

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

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

Check SSL Certificates on remote sites

Chain

/OpenForum/AddOn/SSLCertificateChecker Sevice API Version 0.0.4

Get Actions

Action checkCertificate

Parameters

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

Example Get Request

/OpenForum/AddOn/SSLCertificateChecker?action=checkCertificate&domain=open-forum.onestonesoup.org

Example Response

{
    "result": "ok",
    "message": "Performed action checkCertificate",
    "data": {
        "domain": "open-forum.onestonesoup.org",
        "links": <a href="
            {
                "startTS": 1304406000000,
                "endTS": 1935558000000,
                "start": "Tue May 03 07:00:00 GMT 2011",
                "end": "Sat May 03 07:00:00 GMT 2031",
                "subject": "CN=Go Daddy Secure Certificate Authority - G2, OU=http://certs.godaddy.com/repository/, O=<br/>"GoDaddy.com, Inc.<br/>", L=Scottsdale, ST=Arizona, C=US"
            },
            {
                "startTS": 1251763200000,
                "endTS": 2145916799000,
                "start": "Tue Sep 01 00:00:00 GMT 2009",
                "end": "Thu Dec 31 23:59:59 GMT 2037",
                "subject": "CN=Go Daddy Root Certificate Authority - G2, O=<br/>"GoDaddy.com, Inc.<br/>", L=Scottsdale, ST=Arizona, C=US"
            }
        " target="external_page">
            {
                "startTS": 1304406000000,
                "endTS": 1935558000000,
                "start": "Tue May 03 07:00:00 GMT 2011",
                "end": "Sat May 03 07:00:00 GMT 2031",
                "subject": "CN=Go Daddy Secure Certificate Authority - G2, OU=http://certs.godaddy.com/repository/, O=<br/>"GoDaddy.com, Inc.<br/>", L=Scottsdale, ST=Arizona, C=US"
            },
            {
                "startTS": 1251763200000,
                "endTS": 2145916799000,
                "start": "Tue Sep 01 00:00:00 GMT 2009",
                "end": "Thu Dec 31 23:59:59 GMT 2037",
                "subject": "CN=Go Daddy Root Certificate Authority - G2, O=<br/>"GoDaddy.com, Inc.<br/>", L=Scottsdale, ST=Arizona, C=US"
            }
        </a>,
        "errors": <a href="/OpenForum/AddOn/SSLCertificateChecker/QuickReference/" target="newTab"><img src='/OpenForum/Images/icons/png/link_go.png' /></a>,
        "target": {
            "startTS": 1670590146000,
            "endTS": 1704564858000,
            "start": "Fri Dec 09 12:49:06 GMT 2022",
            "end": "Sat Jan 06 18:14:18 GMT 2024",
            "subject": "CN=open-forum.onestonesoup.org"
        }
    }
}

Example Error Response

Action getCheckedDomains

Parameters

Name	Description

Example Get Request

/OpenForum/AddOn/SSLCertificateChecker?action=getCheckedDomains

Example Response

Example Error Response

Post Actions

OpenForum Tester - A Quick Reference

The OpenForum tester is based around a simple idea. There are three stages to a test:

given some set of data
when some event happens
then some output is expected

The testing frame work is based on a fluent style interface. Methods are chained together to create meaningful flows of actions.

To create a simple test on the server, first import the test framework:

You can run the test using the Tester Client by supplying the pageName and test fileName then pressing run tests. Here is a link to fill in the fields for you. /OpenForum/AddOn/Tester?pageName=/OpenForum/AddOn/Tester/QuickReference&testFileName=example.test.sjs

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: Completed example tests Tests:2 Passed:1 Failed:1 As you can see, the second test failed as it is incrementing rather than decrementing.

Alternatively you can call the Tester get method: https://open-forum.onestonesoup.org/OpenForum/AddOn/Tester?action=runTest&pageName=/OpenForum/AddOn/Tester/QuickReference&testScript=example.test.sjs or run the test on the server using the Server Console editor plugin

Full Reference

/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

Example Response

Example Error Response

QuickReference

Adds user feedback buttons to a page.

text - optional text to display in front of buttons

<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;"> Some text to show <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>

WorkQueue Quick Reference

--8<--
An implementation of Work Queues to manage tasks that need to be processed sequentially.
-->8--

/OpenForum/AddOn/WorkQueue Sevice API Version 0.1.5

Get Actions

Action addItemToQueue

Parameters

Name	Description
name (required=true)	{{parameter.description}}
status (required=true)	{{parameter.description}}
slaTime (required=true)	{{parameter.description}}
data (required=true)	{{parameter.description}}
queue (required=true)	{{parameter.description}}

Example Get Request

/OpenForum/AddOn/WorkQueue?action=addItemToQueue

Example Response

Example Error Response

Action getQueues

Parameters

Name	Description

Example Get Request

/OpenForum/AddOn/WorkQueue?action=getQueues

Example Response

Example Error Response

Action getItemsOnQueue

Parameters

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

Example Get Request

/OpenForum/AddOn/WorkQueue?action=getItemsOnQueue

Example Response

Example Error Response

Action getItemOnQueue

Parameters

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

Example Get Request

/OpenForum/AddOn/WorkQueue?action=getItemOnQueue

Example Response

Example Error Response

Action moveItemToQueue

Parameters

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

Example Get Request

/OpenForum/AddOn/WorkQueue?action=moveItemToQueue

Example Response

Example Error Response

Action setItemStatus

Parameters

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

Example Get Request

/OpenForum/AddOn/WorkQueue?action=setItemStatus

Example Response

Example Error Response

Action setItemData

Parameters

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

Example Get Request

/OpenForum/AddOn/WorkQueue?action=setItemData

Example Response

Example Error Response

Action setItemCompleted

Parameters

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

Example Get Request

/OpenForum/AddOn/WorkQueue?action=setItemCompleted

Example Response

Example Error Response

Action setItemFailed

Parameters

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

Example Get Request

/OpenForum/AddOn/WorkQueue?action=setItemFailed

Example Response

Example Error Response

Post Actions

Action addItemToQueue

Parameters

Name	Description
name (required=true)	{{parameter.description}}
status (required=true)	{{parameter.description}}
slaTime (required=true)	{{parameter.description}}
data (required=true)	{{parameter.description}}
queue (required=true)	{{parameter.description}}

Example Post Request

/OpenForum/AddOn/WorkQueue?action=addItemToQueue

OpenForum Add Ons