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.4

Get Actions

Action getAlerts

Parameters

Name	Description

Example Get Request

/OpenForum/AddOn/Alert?action=getAlerts /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{{action.example.request}} /OpenForum/AddOn/Alert?action=addAlert{{action.example.request}}

Example Response

Example Error Response

Action removeAlert

Parameters

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

Example Get Request

/OpenForum/AddOn/Alert?action=removeAlert{{action.example.request}} /OpenForum/AddOn/Alert?action=removeAlert{{action.example.request}}

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{{action.example.request}} /OpenForum/AddOn/Alert?action=triggerAlert{{action.example.request}}

Example Response

Example Error Response

Action beatAlert

Parameters

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

Example Get Request

/OpenForum/AddOn/Alert?action=beatAlert{{action.example.request}} /OpenForum/AddOn/Alert?action=beatAlert{{action.example.request}}

Example Response

Example Error Response

Action cancelAlert

Parameters

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

Example Get Request

/OpenForum/AddOn/Alert?action=cancelAlert{{action.example.request}} /OpenForum/AddOn/Alert?action=cancelAlert{{action.example.request}}

Example Response

Example Error Response

Quick Reference

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

Quick Reference

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

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

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

/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

Quick Reference

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

ActionLog

Alert

AnonymousSession

Audio

AudioMonitor

AudioNotePad

AudioRecorder

BarcodeScanner

Calendar

ContentEditor

DataLogger

Developer

DocumentGenerator

ImageProcessor

Mailer

Notes

MemberServices

MenuEditor

Publisher

QRCode

Generator

RSSRenderer

ReleasedPackages

RemoteAdministration

RemoteLogger

SQL

ServiceBuilder

SiteMapBuilder

Spider

TileViewer

Update

UserFeedback

WorkQueue