Action Log - Quick Reference

/OpenForum/AddOn/ActionLog Sevice API Version 0.0.7

Get Actions

Post Actions

/OpenForum/AddOn/Alert Sevice API Version 1.0.7

Get Actions

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

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

//A very simple example of transorming data from input to output // //Any text in the input editor is transfered to the variable input when the transform is run //The value of output when the transform finished is transfered to the output editor //In this simple example " some text" is appended to the input data output = input + " some text"; //Add a message to the log print("I've finished");

//An example of transorming data from a json document //An example json input input = '{ "a": 123, "b": 234 }'; //Parse the input data into a json object var json = JSON.parse( input ); //Set the output as the values a and b output = json.a + " , " + json.b + "<br/>n<br/>n"; //Append the json as a pretified string output += JSON.stringify( json, null, 4 ); //Add a message to the log print("I've finished");

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

output = input + " some text";

//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

Post Actions

Mailer Quick Reference

Notes

• https://support.google.com/a/answer/176600?hl=en
• https://support.google.com/a/answer/2956491

Menu Editor - Quick Reference

A menu bar editor.

Generator

Scanner

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

Create a Simple DB Select

Create a DB Select that returns all columns

Create a Simple DB Insert

Create a Simple DB Insert that returns a column

Create a Simple DB Delete

Create a Simple DB Upsert

Create a Simple DB Query

Check SSL Certificates on remote sites

Chain

/OpenForum/AddOn/SSLCertificateChecker Sevice API Version 0.0.4

Get Actions

Post Actions

OpenForum Tester - A Quick Reference

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

1. given some set of data
2. when some event happens
3. 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

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

/OpenForum/AddOn/Update Sevice API Version 0.1.9

Get Actions

Post Actions

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

Post Actions