once:radix Documentation

• once:radix
  • Overview
  • Getting started
  • Fundamentals
  • oADMIN
  • oCLI
  • oED
  • Database
  • Scripting
  • Models
  • Directories
  • Technical Notes

oED script commands

Editing

clear("fieldId")

copy("fieldId")

cut("fieldId")

paste("fieldId")

Element Control

displayElement("elementId", isDisplayed)

displayRowElement("subblockId", "elementId", isDisplayed[, row])

editAsArea("elementId"[, "returnToScript"[, "returnToScriptCancel"[, "readOnly"]]])

Description:	When activated (Browse or Edit mode only), an Area palette opens to display the contents of a field (elementId) to be edited. The function allows Save and/or Cancel buttons to be bound to individual scripts to be performed on exit. The readOnly option disables the Edit button, if TRUE, allowing data to be displayed in the Area palette but preventing it from being changed. The default setting is FALSE.
Example:	editAsArea("txtJobDetails", "textEntered", "entryCancelled");
	Back to Top

fieldIndex("elementId", "metamodelDotRelationship", "modelDotAlias")

focusElement("elementId")

focusRowElement("subblockId", "elementId"[, row])

getActiveElementId()

getElement("elementId")

getElementAsDate("elementId")

getElementAsNumber("elementId")

getEventObject()

getEventScriptId()

getLastShownSubblockRow()

Description:	This statement returns the row number of the last sub-block displayed. The example script below returned the message: when this sub-block was displayed:
Example:	var lastRow; lastRow = getLastShownSubblockRow(); message("Last time you browsed a subblock, there " + (lastRow != 1 ? "were" : "was") + " " + getLastShownSubblockRow() + " row" + (lastRow != 1 ? "s" : "") + " in it (including the new row placeholder)."); return;
	Back to Top

getListIndex("scriptId")

getObject("scriptId")

Description:	Returns the parameters of a screen element in a named array format as defined in the Document Object Model (DOM). In the example below, if the object exists and has a CSS style assigned to it, the border is set at random to: red or blue at a width of two or four pixels, in solid or dotted format. For example, if the element was a text field, in Edit mode it might appear as:
Example:	var activeObject; activeObject = getObject(getActiveElementId()); if(activeObject && activeObject.style) {    activeObject.style.borderColor = Math.random() >= 0.5 ? "red" : "blue";    activeObject.style.borderWidth = Math.random() >= 0.5 ? "2px" : "4px";    activeObject.style.borderStyle = Math.random() >= 0.5 ? "solid" : "dotted"; } else    message("No active object, or active object does not support CSS styles.");
	Back to Top

getRowElement("subblockId", "elementId"[, row])

getRowElementAsDate("subblockId", "elementId"[, row])

getRowElementAsNumber("subblockId", "elementId"[, row])

getRowObject("subblockId", "fieldId"[, row])

goToElement("scriptId")

goToNextField()

goToPreviousField()

isVisible("scriptId")

IsRowElementVisible("subblockId", "elementId"[, row])

setElement("elementId", "value"[, "triggerChange"])

setMenuSource("menuScriptId", "metamodelDotRelationship", "modelDotAlias")

setReadOnly("elementId"[, isReadOnly])

setRowElement("subblockId", "elementId", "value", [row, [triggerChange]])

subblockEditAsArea("subblockId", [row,] "elementId", "returnToScript", "returnToScriptCancel", [readOnly])

Description:	When activated, an Area palette opens to display the contents of a field or other element (elementId) to be edited in the row of subblockId. The function allows Save and/or Cancel buttons to be bound to individual scripts to be performed on exit. The readOnly option disables the Edit button, if TRUE, allowing data to be displayed in the Area palette but preventing it from being changed. The default setting is FALSE.
Example:	subblockEditAsArea("subblock23", 1, "firstname12", "scriptOK()", "scriptCancel()", false);
	Back to Top

Flow Control

(condition) ? executeIfTrue : executeIfFalse

break

cancelEvent()

continue

do {...} while(condition)

for(initialisation; condition; increment) {...}

  *
                             *
     *
                        *
        *
                    *
          *
                  *
            *
                *
             *
               *
              *
              *

for(variable in object) {...}

if (condition) {...} [[else {...}][else if {...}]]

pause("milliseconds")

return [(value)]

scriptname([parameter-1, .. parameter-n])

switch(condition) {case value-1: break; ... case value-n: break; [default: break;]}

try {...} catch(error) {...}

while(condition) {...}

with(variable) {...}

yieldTo("callbackFunction"[, milliseconds, arg1[, ..., argN]])

Gantt Chart

This section of oED has not been implemented. Currently Gantt chart controls are created through direct editing of the XML block files. These script commands will be defined in a future release, once the Gantt Chart palette is available.

getGanttChartDragHeaderKeyValue()
getGanttChartDragIsCopied()
getGanttChartDragSelectedValue("modelDotAlias")
getGanttChartLastClickedColumn("scriptId")
getGanttChartRowCount("scriptId")
getGanttChartRowValue("scriptId", "row")
getGanttChartSelectedColumnValue("scriptId", "modelDotAlias")
getGanttChartSelectedHeaderKey("scriptId")
getGanttChartSelectedRow("scriptId")
getGanttChartSelectedValue("scriptId")
getGanttChartTimeScale("scriptId")
moveGanttChartRowLeft("scriptId")
moveGanttChartRowRight("scriptId")
refreshGanttChart("scriptId")
setGanttChartIgnoreHolidays("scriptId", "ignoreHolidays")
setGanttChartRowByValue("scriptId", "value")
setGanttChartScale("scriptId", "newScale")
sizeGanttChartRowLess("scriptId")
sizeGanttChartRowMore("scriptId")

Help

applicationHelp()

help()

Description:	Loads the help application (oHELP) then attempts to open the index help page defined by the server pathname: ...once/help/application/contacts /index.shtml The example below combines the applicationHelp()and Help() functions to show how to select either the default or index help page when launching oHELP.
Example:	switch(customDialog("Help", "Do you want help for this page or for oCLI?", "Help for This Page", "oCLI Help")) {    case 1:       applicationHelp();       break;    case 2:    default:       help();       break; }
	Back to Top

setHelpPage(["customHelpPage"])

Lists

getLastListSelection ();

pullUpList ("metamodelDotRelationship", "returnAlias",
"onFieldSelectedScript",
"sortByCommaSeparatedList", "sortInAscendingOrderFlag",
"widthInPixels",
"shownModelDotAlias1", "delimeter1",
[... "shownModelDotAliasN", "delimeterN",]
["nullSeparator"
[,"restrictAlias1", "restrictValue1", "isDateRestriction1"
[,..."restrictAliasN", "restrictValueN", "isDateRestrictionN"]]]
[,"disableClearButton"]);

pullUpListWithCustomButton ("buttonScript", "buttonText",
"metamodelDotRelationship", "returnAlias",
"onFieldSelectedScript",
"sortByCommaSeparatedList", "sortInAscendingOrderFlag",
"widthInPixels",
"shownModelDotAlias1", "delimeter1",
[... "shownModelDotAliasN", "delimeterN",]
["nullSeparator"
[, "restrictAlias1", "restrictValue1", "isDateRestriction1",
[, ... "restrictAliasN", "restrictValueN", "isDateRestrictionN"]]]
[, "disableClearButton"]);

setPullUpListDistinct ();

Login Management

getGMT()

getLicenseInfo()

getLoginBranch()

getLoginCanUseAdministration()

getLoginCanUseClient()

getLoginCanUseEditor()

getLoginDateFormat()

getLoginFirstName()

getLoginIsAutoResized()

getLoginLastName()

getLoginLocation()

getLoginOrganization()

getLoginOwnerOrganisation()

getLoginPersonmember()

getLoginSession()

getLoginTimeFormat()

getLoginUsername()

logout()

Messages

confirm("message")

ask("message"[, "windowTitle"])

askWithCancel("message"[, "windowTitle"])

customDialog("windowTitle", "question"[, "button1"[, "button2"[, "button3"]]])

Description:	This function allows more flexible dialog boxes to be created that can include a custom window title (windowTitle), question or statement (question), and up to three custom buttons. In the example below, the following custom dialog would be created:
Example:	customDialog("What next?", "There's a fork in the path, and the cave continues in two directions from here. You can proceed to either the left or right" + ".", "Go left", "Go right", "Go back");
	Back to Top

input("question", "defaultValue")

message("text")

Modes

cancelEditMode()

cancelSubblockRowEdit("subblockId", "rowNumber")

enterBrowseMode()

enterEditMode()

enterFindMode(["rememberLastFind"])

getMode()

isSubblockRowUnlocked("subblockId", rowNumber)

lockSubblockRow("subblockId", row, alwaysCommit)

modeLock(isLocked)

setKioskMode(isEnabled)

unlockSubblockRow("subblockId", row)

Navigation

firstRecord()

getBlockName()

goToLayout("block"[, "find-field", "find-value"[, "sort-field"[, "ascending"[, "waitUntilLoaded"]]]])

goToRecord(record)

goToSubblockRow("subblockId", rowNumber)

isLoadingBlock()

lastRecord()

nextRecord()

previousRecord()

Records

clearLastInsertedRecord("elementId")

currentRecord()

currentSubblockRecord ("subblockId")

deleteAllRecords([showAlert])

deleteAllSubblockRecords("subblockId"[, showAlert])

deleteRecord([showAlert])

deleteRecords("model", "keyFieldAlias", "keyValue", isDateValue, isNumericValue[, "callbackFunction"])

deleteSubblockRow("subblockId", row, showAlert)

duplicateRecords("model", "searchAlias", "searchValue",
["isDateSearch",] ["replaceAlias1", "replaceValue1"
[... , "replaceAliasN", "replaceValueN"][, "returnAlias"]])

duplicateRecordsReplaceFromList("model",
"searchAlias", "searchValue", ["isDateSearch",]
"replaceAlias", "replaceValueList"[, "returnAlias"]) ")

exportRecords("exportType", "templateFile", "exportFields", "exportGroupAliasList", "MYOBconstantNameList", "MYOBconstantValueList", "MYOBflaggedAlias") ")

flushCache()

getLastInsertedRecordValue("columnName", "elementId")

getModifiedSubblockRows("subblockId")

importRecords ()

insertRecord("modelName", "alias1", "value1", "alias2", "value2", ... "aliasN", "valueN") ")

insertRecords("modelName", aliasList, valueList1, valueList2, ..., valueListN)

insertRecordsFromArrays("modelName", aliasList, valueListList, ["callbackFunction"])

lockSubblockRow ("subblockId", "row", "alwaysCommit")

newRecord()

replaceData("model", searchAliasList, searchValueList, isDateSearchList, replaceAliasList, replaceValueList)

restrictSubblockView("subblockId", isDateSeries, "dateFormat", "modelDotAlias1", "value1", "modelDotAlias2", "value2", ... "modelDotAliasN", "valueN")

revertRecord()

selectRecords("modelName", "alias1", "=value1", "alias2", "=value2", ... "aliasN", "=valueN", nullSeparator, "sortAlias1", isAscendingOrder1, "sortAlias2", isAscendingOrder2, ... "sortAliasN", isAscendingOrderN)

setRowElement ("subblockId", "elementId", "value", "row", "triggerChange")

shiftRecordsByDays("metamodelDotRelationship", "days", "restrictAliasList", "restrictOperatorList", "restrictValueList", "restrictIsDateList", "aliasToShiftList", "skipHolidays")

submitRecord(alwaysCommit)

totalRecords()

totalSubblockRecords("subblockId")

unlockSubblockRow ("subblockId", "row")

unrestrictSubblockView("subblockId", doNotRefresh)

Security

cleanBlockPermissions("groupKey"[, ignoreErrors[, defaultDelete[, defaultModify[, defaultRead[, defaultWrite]]]]])

cleanTablePermissions("groupKey"[, ignoreErrors[, defaultDelete[, defaultModify[, defaultRead[, defaultWrite]]]]])

getLastBlockPermissionsCreated()

getLastBlockPermissionsRemoved()

getLastTablePermissionsCreated()

getLastTablePermissionsRemoved()

Sort Find Print

addSort("fieldId", "ascending") implemented as addSort("field1[,field2[,field3]...]", "order1[,order2]...")

clearSort()

createSort()

doSort()

findAllRecords()

getSorts() throwns the error (Error: [Exception... "'Error: Query index out of bounds (0 to 4)' when calling method: [nsIDOMEventListener::handleEvent]" nsresult: "0x8057001c (NS_ERROR_XPC_JS_THREW_JS_OBJECT)" location: "<unknown>" data: no]) ####

performFind("fields", "values", ignoreErrors)

print("rtfTemplate", "outputFormat", startRecord, stopRecord)

printWithDialog("defaultFormat", defaultStartRecord, defaultStopRecord, "onCloseScript", "overrideTemplate")

refineLastFind(field, value, field-n, value-n)

showAllRecords()

sortSubblock("subblockId", "modelDotAlias1", isAscendingOrder1, "modelDotAlias2", isAscendingOrder2, "modelDotAliasN", isAscendingOrderN)

Text

formatAsDate("number"[, "dateFormat"])

Description:	This function converts the parameter number from numeric format to a date format. The default format is set when the user logs on. This can be overridden by including the optional parameter dateFormat. In the example below, the message displays the day of the week, date and month as shown:
Example:	message("The next day after the current completed date is:\n" + formatAsDate(getElementAsDate("txtDateCompleted") + (24 * 60 * 60), "[dddd] the [ddd] of [mmmm]"));
	Back to Top

formatAsNumber("number", "numberFormat")

getDateNumber("dateText"[, "dateFormat")

left("text", "length")

Description:	This function selects characters starting from the first character in a string for a number of characters specified by the parameter length. In the example below, the contact's first name is found by selecting all characters to the left of the first space character ('Frederick'), as shown below:
Example:	var contact = "Frederick John Smith"; var firstName; firstName = left(contact, position(contact, " ", 1,1) - 1); message(firstName);
	Back to Top

length("text")

Description:	This function returns the length of a string as an integer. In the example below, the length of the name (Frederick John Smith) is calculated and displayed as shown below:
Example:	var contact = "Frederick John Smith"; var firstName; firstName = left(contact, position(contact, " ", 1,1) - 1); message(firstName);
	Back to Top

lowerCase("text")

Description:	This function converts the specified text to lower case. In the example below, the contact's middle name is found by selecting all characters between the first and second space characters, then it is changed from upper case to lower case ('JOHN' to 'john'), as shown below:
Example:	var contact = "Frederick JOHN Smith"; var middleName = lowerCase(middle(contact,    position(contact, " ", 1,1) + 1, position(contact, " ", 1,2) -    position(contact, " ", 1,1) - 1)); message(middleName);
	Back to Top

middle("text", "start", "length")

Description:	This function selects characters from a string, from the specified start position for a number of characters specified by the parameter length. In the example below, the contact's middle name is found by selecting all characters between the first and second space characters, then it is changed from upper case to lower case ('JOHN' to 'john'), as shown below:
Example:	var contact = "Frederick John Smith"; var middleName; middleName = middle(contact, position(contact, " ", 1,1) + 1,    position(contact, " ", 1,2) - position(contact, " ", 1,1) - 1); message(middleName);
	Back to Top

position("text", "search", "start", "occurrence")

Description:	####
Example:	var contact = "Frederick John Smith"; var lastName; lastName = right(contact, length(contact) -    position(contact, " ", 1,2)); message(lastName);
	Back to Top

right("text", "length")

Description:	####
Example:	var contact = "Frederick John Smith"; var lastName; lastName = right(contact, length(contact) -    position(contact, " ", 1,2)); message(lastName);
	Back to Top

substitute("text", "search", "replace")

Description:	####
Example:	var contact = "Frederick John Smith"; var middleName; middleName = substitute(contact, "John", "Jack"); message(middleName);
	Back to Top

upperCase("text")

Description:	####
Example:	var contact = "Frederick John Smith"; var middleName; middleName = upperCase(middle(contact, position(contact, " ",    1,1) + 1, position(contact, " ", 1,2) - position(contact, " ",    1,1) - 1)); message(middleName);
	Back to Top

Thumbnails

setRowThumbnailSection("subblockId", "elementId", "row", "sectionName")

setThumbnailSection("elementId", "sectionName")

Variables

getGlobal("variableName")

parseFloat(string, number-base)

parseInt(string, number-base)

parseNumber("text")

quickSort(array)

setGlobal("variableName", "variableValue")

var variableName

Windows

getWindowHeight()

Description:	This function returns the height of the currently selected window as an integer. In the example below, the message could be:
Example:	message("Window height is: " + getWindowHeight())
	Back to Top

getWindowWidth()

Description:	function returns the width of the currently selected window as an integer. In the example below, the message could be:
Example:	message("Window width is: " + getWindowWidth())
	Back to Top

openNewWindow("URL"[, "name"])

Description:	This command allows applications to load standard HTML web pages from withing a once:radix application. It opens a new window or tab with the address set to the URL. The browser Preferences can be configured to always open HTML pages into a new window or tab. For example, in Camino open the Tabs option in Preferences..., then select: There are four standard name tags that can be appended to this command: _blank, _parent, _self and _top. If no name is specified, the default setting is _blank; which has the effect of opening a new window or tab. The other three standard W3C options should not be used as they have the effect of navigating away from your application. If you wish to re-open the same window or tab each time the command is executed, specify a non-standard name. In the example below, a new window or tab is opened to display the HTML page (www.onceradix.com), the first time the command is executed. The window or tab is given the name: 'catalog'. The second command loads the new page (www.oncefabrik.com) into the same window or tab. It will continue to load all subsequent HTML pages referred to as _catalog into the same window or tab. The third command loads the page into a new window or tab, as does the fourth command. So, in this example, three new windows and tabs are created.
Example:	openNewWindow("www.onceradix.com", "_catalog") openNewWindow("www.oncefabrik.com", "_catalog") openNewWindow("www.onceradix.com") openNewWindow("www.oncefabrik.com")
	Back to Top

openPalette("paletteName", xValue, yValue)

refreshBlock()

refreshSubblock("scriptId")

refreshSubblocks()

WWW

download("fileURL")

mailTo("address", "CC", "BCC", "subject", "body")

openURL("url")

sendEmail("subject", "body", toList, CCList, BCCList, "from"[, "replyTo"[, "doAttachPrintJob", "outputFormat", "templateName", ["startRecord", "stopRecord"]]])