Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 3 Next »

Introduction

Below is a list of methods grouped by the resource they interact with. These methods are available to the page under the fb_client object that is injected into the browser window. Unfortunately, we are unable to interact with these methods using native objects. So passing complex data is done by serializing objects into JSON strings, and vice-versa.

Methods

Database

String runQuery(String sql)

Executes a SQL string, and returns an array of records as JSON objects. If there is an error, it returns an object. Note: All result properties will be returned in lowercase.

Examples

Return a basic query with a single row.

var results = fb_client.runQuery("select * from company");

Return a basic query with multiple rows.

var results = fb_client.runQuery("select * from so limit 10");

What happens with a syntax error.

var results = fb_client.runQuery("select *, from so limit 10");

String runQueryParameters(String sql, String json_parameters);

Executes a SQL string like runQuery, but accepts a single object with parameters serialized as JSON. To define a parameter use :name syntax, and use all lower case parameter names in SQL and in the JSON object.

Examples

Query sales orders by a specific customer id.

var params = JSON.stringify({customer_id:5});
var results = fb_client.runQueryParameters("select * from so where customerid = :customer_id", params );

API - REST

restApiCall(String method, String path, String body)

Makes an HTTP API call, re-using the Fishbowl Client connection, via the Java networking stack. This is a BETA feature, and is not guaranteed to work correctly or break in the future. You can find REST swagger docs using the Fishbowl Server web port, reference: XXXX.

Example

Get company information

var result = fb_client.restApiCall("GET","/company");
console.log(result);

API - Legacy

String runImportCSV(String import_type, String csv_data)

Creates and executes a ImportRequest, given a string of an import_type (Reference: XXX) and a CSV string. The method returns a JSON object as a string.

Examples

Import a Custom Field Data Import

var csv = "";
var import_type = "ImportCustomFieldData";
var result = fb_client.runImportCSV(import_type, csv);
console.log(result);
> ""

String runApiJSON(String request_type, String json_payload)

Executes a legacy API call given a request_type, see reference (XXXXX), and a JSON Payload. The internal Fishbowl Legacy API is XML, and Fishbowl will convert our JSON to XML, and on a completed request will convert XML to JSON.

Examples

TBD

var request = {};
var request_json = JSON.stringify(request);
var result_json = fb_client.runApiJSON("XXX",request_json);
var result = JSON.parse(result_json);
console.log(result);
> TBD

Window

boolean dialogClose()

Closes the current browser window. Warning, the page execution will stop once the browser is closed.

Example

var closing = fb_client.dialogClose();

Client

int getUserId()

Returns an int of the current user id.

Example

var user_id = fb_client.getUserId();
console.log(user_id);
> 1

String getUsername()

Returns a string of the current username.

Example

var user_name = fb_client.getUsername();
console.log(user_name);
> "admin"

boolean savePluginDataByGroup(String group_name, String data_dictionary)

Saves data (JSON or Plain String) to the Fishbowl Plugin data tables (plugindata). The data dictionary is expected to be a JSON object (single level, no hierarchy).

Example

TBD

String getPluginData(String group_name, String key)

Retrieves a string, given a group_name, and key.

Example

void deletePluginData(String group_name)

Deletes plugin data by the group_name.

Example

String getModuleName()

Returns the current module’s name, from where it was launched.

Example

var module_name = fb_client.getModuleName();
console.log(module_name);
> "Sales Order"

boolean reloadObject()

Reloads/refreshes the current modules object.

Example

var refreshed = fb_client.reloadObject();

void hyperLink(String module, String param)

Launches a Fishbowl module by name, and if provided the param should open the record.

Example

Launch the Customer Module, and open Customer ID 5;

fb_client.hyperLink("Customer","5");

File

String getResourceFileString(String filename)

Retrieves a file name from the root of the page folder. Warning: We do check for path traversal.

Example

Read a SQL file as a string.

var query_sql = fb_client.getResourceFileString("sql/test.sql");

String getResourceFileAsBase64(String filename)

Retrieves a file name from the root page of the folder, as a Base64 string of bytes. Warning: We do check for path traversal.

Example

Read an image file as Base64 string. 

var image_b64 = fb_client.getResourceFileString("images/example.png");

console.log(image_b64);
# > .....

void saveDataToFile(String title, String extension, String extension_description, String base64_data)

Displays a Java JFileChooser dialog so we can influence, control the window, and file filter in the dialog from JavaScript.

Example

Save a CSV.

var csv = "";

fb_client.saveDataToFile("Save CSV","csv","Excel (CSV)", btoa(csv) );
  • No labels