Page Comparison

Method Name

Parameters

Purpose

FRTB.request(d)

details object.

Create a FileMaker request. This request object may perform multiple database operations during the same request.

FRTB.find(f1,f2,f3,...)

Any number of fields to find.

Used find FileMaker records. Use in conjunction with .where(). Limited to a single request.

FRTB.create([f1,v1],[f2,v2],...)

Any number of field/value pairs.

Used to create FileMaker records. Limited to a single request.

FRTB.update([f1,v1],[f2,v2],...)

Any number of field/value pairs.

Used to update matched FileMaker record. Use in conjunction with .where(). Limited to a single request.

FRTB.remove(t)

Table occurrence name you want to delete records from.

Used to delete a FileMaker record. Use in conjunction with .where(). Limited to a single request.

FRTB.calc(c)

Calculation to perform.

Perform a FileMaker calculation and return the result to your JavaScript. Limited to a single request. Best used with a database name.

FRTB.script(s,p)

Script to run, Parameter to pass

Run a FileMaker script, and pass a parameter. Does not return script result. Must be used in conjunction with a Database Name.

Method Name

Parameters

Purpose

request.where({w1},{w2}...)

Any number of where objects, or a single SQL WhereClause string.

Specifies the records you want to effect with this request. May be used in conjunction with filter if required.

request.filter(f)

A filter string.

Provides a user friendly syntax for providing arbitrary filters on a request. Can be used either independently or in conjunction with a 'where' statement.

request.send(d)

A details object, or a success callback handler

Starts the request - sends off the request and returns the result to the success handler (if successful).

request.debug(c)

Optional callback function.

Performs requests on the database to find out about missing or misnamed fields and tables. Then prints the output to the debug log, and a message dialogue, or returns an array of errors to the callback function if provided.

request.poll(f,t)

Poll handler function, and interval timer in milliseconds.

Lets you easily implement record modification, deletion and addition checking on a set of records.

Function Name

Parameters

Purpose

FRTB.setDefault(d,v)

The default to set, value to set it to.

Gives you the ability to set certain default values for use in the requests or other areas. E.g
FRTB.setDefault( 'DatabaseName', 'MyDB' )
would cause each request to use 'MyDB' unless explicitly overridden as a part of the request.

FRTB.getVersion()

Gets the current FRTB version number

FRTB.startDebugging()

Provides detailed debugging output to the console from the high and low level ToolBox functions.

FRTB.getLastError()

Gets the error object for the last request that returned an error from Reactor.

FRTB.getSQLDate(d)

The JavaScript date object you want to convert.

Convert a JavaScript date object to a formatted Date string for use in an SQL request.

FRTB.getSQLTime(d)

The JavaScript date object you want to convert.

Convert a JavaScript date object to a formatted Time string for use in an SQL request.

FRTB.convertDateTime(d)

The SQL date string you want to convert.

Converts a date string returned from the SQL engine in to a JavaScript date object.

FRTB.getTOName(f,e)

The field you want to get the TO from, whether to escape/quote it for an SQL string.

Parses the TO name from a FileMaker fully qualified field string. Allows you to return the raw TO name, or have the TO name escaped and quoted for use within an SQL string.

FRTB.getFieldName(f,e)

The field you want to get the Field from, whether to escape/quote it for an SQL string.

Parses the Field name from a FileMaker fully qualified field string. Allows you to return the raw Field name, or have the Field name escaped and quoted for use within an SQL string.

FRTB.getAction(a,i,c)

The action string you want to parse into an action object,
The action identifier to use in .performAction,
the completion function to run if using SetField (automatically gets the current value of that field).

Allow users the ability to flexibly supply or modify a simple database request. Gives the user the ability to set a field, or run a script with user provided parameters.

FRTB.performAction(i,p,c)

The action ID that you want to execute,
The parameter (or record set) you want to pass as a parameter,
The completion function to execute after performing this action.

Trigger the action, using the second value as a parameter.

Option

Default

Description

onsuccess

The completion function to call with the result on a successful request.

onerror

(internal request debugger)

The completion function to call on a failed request.

onrecordlock

Runs FR_Commit Record script and tries original request again.

The completion function to call when FileMaker reports a locked record.

creationvalues

Allows you to specify creation values in the format passed by the FileMaker plugin function 'bbdev_relationshipKeyBuilder'.

distinct

false

Add the 'DISTINCT' SQL keyword to your find request.

databasename

(current database)

The database name to run the request on. In the case of a script request, the script will be executed on this database. In the case of any other request, Reactor will check if the specified database is open in the front most window before executing the request, otherwise it will return an error.

layoutname

The layout name to run the request on. Reactor will check if the specified layout is open in the front most window before executing the request, otherwise it will return an error.