context

assignToGroup ( record: Record , groupRef: Group, String, privilege: Privilege, String)

Assigns a privilege on a particular model to a Group

Parameters

Context: serversideApplication

Tags: standard

assignToRole ( item: Record, Model, roleRef: String/Role-ID, privilege: Privilege, String)

Assigns a privilege on a particular model to a Role

Parameters

Context: serversideApplication

Tags: standard

assignToUser ( record: Record , userRef: Record,User, String, privilege: Privilege, String)

Assigns a privilege on a particular model to a User

Parameters

Context: serversideApplication

Tags: standard

begin ( )

Initiate a database transaction. Always follow by doing a commit or a rollback.

Context: serversideRuntime

Tags: standard

clearData ( key: String) →{ Object }

Parameters

Context: serversideDevice

commit ( )

Commits a database transaction

Context: serversideRuntime

Tags: standard

create ( object: Record, Object, options: Object) →{ Record }

Creates a Record in the database. Should be done within the context of a transaction.

Parameters

Context: serversideApplication

Tags: standard

create ( object: Object) →{ Promise }

Parameters

Context: serversideDevice

createAnonymousAccessURL ( email: String, ui: String, view: String, id: Object, options: Object) →{ String }

Creates a URL providing unauthenticated access to a particular view. Note that the view must be part of a UI that is marked as public.

Parameters

Context: serversideRuntime

Tags: basic

createAs ( object: Record, Object, user: User , options: Object) →{ Record }

Creates a Record in the database as a given User. Should be done within the context of a transaction.

Parameters

Context: serversideApplication

Tags: standard

createEmailAddress ( key: String) →{ String }

Creates an email address that routes to this application

Parameters

Context: serversideRuntime

Tags: standard

createFile ( source: Object, options: Map) →{ File }

Creates file using source object, context-type and filename

Parameters

Context: serversideRuntime

Tags: basic

createJWT ( header: Map, payload: Map, keys: Map) →{ String }

Generates a custom JWT

Parameters

Context: serversideRuntime

Tags: basic

createPromise ( ) →{ Promise }

Context: serversideRuntime

Tags: basic

createRecord ( modelName: String/Model-ID, data: Object, binary: Object) →{ Record }

Creates a Record given the name of a Model and a map of attribute-values. Note that this does not create a Record in the database, it just creates a Record-object that can be passed to database-operations.

Parameters

Context: serversideRuntime

Tags: basic

createRecordSet ( name: String, data: Object) →{ RecordSet }

Creates a RecordSet out of an array or an object of named arrays.

Parameters

Context: serversideRuntime

Tags: standard

delete ( model: String/ID, idStr: String)

Deletes a Record from the database. Should be done within the context of a transaction.

Parameters

Context: serversideApplication

Tags: standard

delete ( object: Object, options: Map)

Deletes a Record from the database. Should be done within the context of a transaction.

Parameters

Context: serversideApplication

Tags: standard

deleteAs ( object: Object, user: User , options: Map)

Deletes a Record from the database as a given User. Should be done within the context of a transaction.

Parameters

Context: serversideApplication

Tags: standard

executeQuery ( name: String/Query-ID, args: Object) →{ QueryResult }

Gets the results of the specified query

Parameters

Context: serversideRuntime

Tags: standard

executeTemplate ( options: Map) →{ String }

Executes a template given a set of parameters

Parameters

Context: serversideApplication

Tags: standard

fail ( error: String)

TODO

Parameters

Context: serversideRuntime

Tags: basic

get ( model: String/Model-ID, idStr: String, options: Object) →{ Record }

Get a single Record from the database given its ID.

Parameters

Context: serversideApplication

Tags: standard

get ( modelObj: Object, idObj: Object) →{ Promise }

Parameters

Context: serversideDevice

getAndClearData ( key: String) →{ Object }

Parameters

Context: serversideDevice

getAppConfig ( ) →{ Map }

Gets the application-configuration for the current Tenant

Context: serversideRuntime

Tags: basic

getAppliance ( ) →{ Appliance }

Context: serversideDevice

getApplianceId ( ) →{ Object }

Gets the ID of the appliance that the code is running on

Context: serversideRuntime

Tags: basic

getAs ( model: Object, idStr: Object, user: User , options: Map) →{ Record }

Get a single Record from the database as a given User given its ID.

Parameters

Context: serversideApplication

Tags: standard

getConfig ( ) →{ Config }

Context: serversideRuntime

Tags: integration

getConfigParam ( name: String/ConfigParam-ID) →{ ConfigParam }

Returns a configuration parameter using the specified name, or null if no such parameter exists.

Parameters

Context: serversideApplication

Tags: basic

getCredentials ( ) →{ Config }

Context: serversideRuntime

Tags: integration

getData ( key: String, defaultValue: Object) →{ Object }

Parameters

Context: serversideRuntime

Tags: basic

getDataFunctions ( ) →{ DataFunctions }

Gets the DataFunctions API

Context: serversideRuntime

Tags: basic

getDateFunctions ( ) →{ DateFunctions }

Gets the DateFunctions API - an API for handling Dates

Context: serversideRuntime

Tags: basic

getId ( ) →{ long }

TODO

Context: serversideRuntime

Tags: standard

getIntegration ( name: String/Integration-ID) →{ Object }

Gets a named Integration-module

Parameters

Context: serversideRuntime

Tags: basic

getLocale ( ) →{ Locale }

Returns the current locale.

Context: serversideRuntime

Tags: basic

getMail ( ) →{ Mail }

Gets the incoming Mail that triggered the execution of this Action

Context: serversideREST

Tags: standard,action,REST

getMessage ( ) →{ Message }

Gets the incoming Message that triggered the execution of this Action

Context: serversideREST

Tags: standard,action,REST

getMilliTime ( ) →{ long }

Context: serversideDevice

getModule ( moduleName: String) →{ Object }

Parameters

Context: serversideDevice

getNanoTime ( ) →{ long }

Context: serversideDevice

getNextCounterValue ( name: String) →{ String }

TODO

Parameters

Context: serversideApplication

Tags: standard

getNextCounterValueLong ( name: String) →{ Integer }

TODO

Parameters

Context: serversideApplication

Tags: standard

getPreviousRecord ( ) →{ Record }

Get Previous Record

Context: serversideRuntime

Tags: standard,action,DATA

getRecord ( ) →{ Record }

Get Record

Context: serversideRuntime

Tags: standard,action,DATA

getRequest ( ) →{ ServiceRequest }

Gets the HTTP-request that triggered the execution of this Action

Context: serversideRuntime

Tags: action,REST

getResponse ( ) →{ ServiceResponse }

Gets the HTTP-response that is associated with the HTTP-request that triggered this Action

Context: serversideRuntime

Tags: standard,action,REST

getSchema ( ) →{ Schema }

Returns the Schema of the current App.

Context: serversideRuntime

Tags: basic

getServiceRequestHeaders ( ) →{ Object }

Gets the request headers and returns them as an object.

Context: serversideREST

Tags: standard,action,REST

getServiceRequestParameter ( name: String) →{ String }

Gets the value of an URI parameter in the request.

Parameters

Context: serversideREST

Tags: action,REST

getString ( name: String, vars: Map) →{ String }

Gets a String from the applications String-resources and performs variable substitution using the given parameters.

Parameters

Context: serversideRuntime

Tags: basic

getString ( name: String) →{ String }

Gets a String from the applications String-resources

Parameters

Context: serversideRuntime

Tags: basic

getSystemManager ( ) →{ SystemManager }

TODO

Context: serversideREST

Tags: standard

getTags ( ) →{ Object }

Context: serversideDevice

getTenantId ( ) →{ String }

Returns the ID of the current user's tenant.

Context: serversideRuntime

Tags: basic

getTokenProperty ( key: String) →{ Object }

Gets a custom property from the access-token

Parameters

Context: serversideRuntime

Tags: basic

getURL ( ) →{ String }

Gets the server base-URL

Context: serversideRuntime

Tags: standard

getURL ( userInterface: String, view: String, recordId: String/ID, params: Object) →{ String }

Gets the url of a specific view

Parameters

Context: serversideRuntime

Tags: standard

getUser ( ) →{ User }

Gets the current User

Context: serversideRuntime

Tags: basic

hasFeature ( name: String) →{ boolean }

Checks for the presence of an application-feature

Parameters

Context: serversideRuntime

Tags: basic

hash ( data: String, algorithm: String) →{ String }

Compute the hash of a string using a given algorithm

Parameters

Context: serversideRuntime

Tags: basic

hasRequest ( ) →{ boolean }

True if there is a pending REST request

Context: serversideRuntime

Tags: standard,action,REST

hasResponse ( ) →{ boolean }

True if it is possible to respond to a pending REST request

Context: serversideRuntime

Tags: standard,action,REST

http ( options: Map) →{ Promise }

Sends an HTTP-request

Parameters

Context: serversideRuntime

Tags: basic

inTransaction ( ) →{ boolean }

Checks whether is an active database transaction in place

Context: serversideRuntime

Tags: standard

invoke ( funcName: String, args: Map) →{ Object }

Parameters

Context: serversideDevice

invoke ( funcName: String) →{ Object }

Parameters

Context: serversideDevice

invokeAction ( actionRef: Object, recordObj: Object) →{ ActionResult }

Executes an action

Parameters

Context: serversideApplication

Tags: standard

isUserAllowed ( record: Record , userRef: User, String, privilege: Privilege, String) →{ boolean }

Checks if a User has a certain privilege on a Record

Parameters

Context: serversideApplication

Tags: standard

jsonpath ( path: String, document: Object) →{ Object }

Executes a jsonpath-expression on the provided JSON-document

Parameters

Context: serversideRuntime

Tags: basic

log ( level: Object, message: Object[])

Log a message to the application-log with a given severity (one of TRACE, DEBUG, INFO, WARN, ERROR)

Parameters

Context: serversideRuntime

Tags: basic

log ( message: Object)

Log a message to the application-log

Parameters

Context: serversideRuntime

Tags: basic

lookupGroup ( name: String) →{ Group }

Looks up a Group given its name

Parameters

Context: serversideApplication

Tags: standard

lookupUser ( name: String) →{ User }

Lookup a User given his username

Parameters

Context: serversideApplication

Tags: standard

parseHTML ( html: String) →{ Document }

Parses html string

Parameters

Context: serversideRuntime

Tags: basic

parseXML ( xml: String) →{ Document }

Parses xml string

Parameters

Context: serversideRuntime

Tags: basic

publish ( topic: String, message: Map, headers: Map)

Publish a message to the bus

Parameters

Context: serversideRuntime

Tags: basic

publish ( topic: String, message: Map)

Publish a message to the bus

Parameters

Context: serversideRuntime

Tags: basic

query ( queryStr: String/Query-ID, params: Object, user: User ) →{ Result }

Executes a query using the provided parameters

Parameters

Context: serversideRuntime

Tags: standard

queryForArray ( query: String/Query-ID, params: Object, user: User ) →{ Array }

Executes a query using the provided parameters and returns the resulting records as an array

Parameters

Context: serversideRuntime

Tags: standard

queryForSingle ( query: String/Query-ID, params: Object, user: User ) →{ Record }

Executes a query using the given parameters and returns just the first record or null

Parameters

Context: serversideRuntime

Tags: standard

randomString ( size: int) →{ String }

Generates a randomized alphanumeric string of a given size (default is 16 characters)

Parameters

Context: serversideRuntime

Tags: basic

readServiceRequestObject ( ) →{ Object }

Reads the request data and returns it as an object.

Context: serversideREST

Tags: standard,action,REST

reboot ( hard: boolean)

Parameters

Context: serversideDevice

requestExecutionTime ( milliseconds: int) →{ boolean }

Requests an extension of this actions runtime

Parameters

Context: serversideApplication

Tags: standard

revokeFromGroup ( record: Record , groupRef: Group, String, privilege: Privilege, String)

Revokes a privilege on a particular model from a Group

Parameters

Context: serversideApplication

Tags: standard

revokeFromRole ( record: Record , roleRef: Role, String, privilege: Privilege, String)

Revokes a privilege on a particular model from a Role

Parameters

Context: serversideApplication

Tags: standard

revokeFromUser ( record: Record , userRef: User, String, privilege: Privilege, String)

Revokes a privilege on a particular model from a User

Parameters

Context: serversideApplication

Tags: standard

rollback ( )

Rolls back a database transaction

Context: serversideRuntime

Tags: standard

scheduleTask ( options: Map) →{ TimerTask }

Parameters

Context: serversideDevice

sendHttpRequest ( options: Map) →{ HttpResponse }

Send an http-request

Parameters

Context: serversideRuntime

Tags: basic

sendMail ( options: Map) →{ boolean }

Sends an email to one or more recipients

Parameters

Context: serversideRuntime

Tags: standard

sendPush ( pushObject: Map) →{ boolean }

Sends a push-notification to one or more recipients

Parameters

Context: serversideRuntime

Tags: standard

sendServiceResponseError ( errorCode: int, message: String)

Sends an error to the client that invoked the rule

Parameters

Context: serversideREST

Tags: action,REST

sendSMS ( smsObject: Map) →{ boolean }

Sends an SMS to one or more recipients

Parameters

Context: serversideRuntime

Tags: standard

setData ( key: String, value: Object, scope: String)

Parameters

Context: serversideRuntime

Tags: basic

setServiceResponseHeaders ( headers: Object)

Sets the response headers to be the fields in the provided object.

Parameters

Context: serversideREST

Tags: standard,action,REST

sleep ( millis: long, nano: int)

Parameters

Context: serversideDevice

sleep ( millis: long)

Parameters

Context: serversideDevice

store ( object: Record, Object) →{ Record }

Stores a Record in the database. This will either create or update the Record depending on whether the record already exists.

Parameters

Context: serversideApplication

Tags: standard

storeAsUser ( object: Record, Object, user: User ) →{ Record }

Stores a Record in the database as a given User. This will either create or update the Record depending on whether the record already exists.

Parameters

Context: serversideApplication

Tags: standard

tx ( transaction: Runnable, onSuccess: Runnable, onError: Consumer) →{ boolean }

Perform a set of operations wrapped inside a database transaction. When the function returns the transaction is commited, if an error occurs the transaction is rolled back. If the transaction is successfully committed the method returns true.

Parameters

Context: serversideRuntime

Tags: standard

update ( object: Record, Object, options: Object) →{ Record }

Updates a Record in the database. Should be done within the context of a transaction.

Parameters

Context: serversideApplication

Tags: standard

update ( recordObj: Object) →{ Promise }

Parameters

Context: serversideDevice

updateAs ( object: Record, Object, user: User , options: Object) →{ Record }

Updates a Record in the database as a given User. Should be done within the context of a transaction.

Parameters

Context: serversideApplication

Tags: standard

waitForAll ( promises: Object[]) →{ Promise }

Parameters

Context: serversideRuntime

Tags: basic

writeServiceResponseObject ( data: Object)

Sends a response using the specified object.

Parameters

Context: serversideREST

Tags: standard,action,REST