Servoy

https://docs.servoy.com/
Admin
Servoy provides a platform and tools to get up and running with building applications, offering...
Tokens:1,055,080
Snippets:13,096
Trust Score:9.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### start(packageReceivedCallback)

Source: https://docs.servoy.com/reference/servoyextensions/server-plugins/udp/udpsocket.md

Starts the socket to listen for incoming packets.

```APIDOC
## start(packageReceivedCallback)

### Description
Starts the socket to listen for incoming packets, no need to call this method if you only want to send packets. The given function will be called when a packet is received.

### Parameters
- **packageReceivedCallback** (Function) - The callback function that will be called when a package is received.

### Returns
- **UDPSocket** - The UDPSocket instance, allowing method chaining.
```

--------------------------------

### start(packageReceivedCallback)

Source: https://docs.servoy.com/reference/servoyextensions/server-plugins/udp/udpsocket.md

Starts the socket to listen for incoming packets, no need to call this method if you only want to send packets.

```APIDOC
## start(packageReceivedCallback)

### Description
Starts the socket to listen for incoming packets, no need to call this method if you only want to send packets.

### Parameters
- **packageReceivedCallback** (Function) - The callback function to execute when a packet is received.

### Returns
- **UDPSocket**
```

--------------------------------

### Amortization Calculation Setup

Source: https://docs.servoy.com/reference/servoyextensions/server-plugins/amortization/amortizationcalculation.md

Common setup pattern for initializing an amortization calculation and adding various events.

```javascript
var c = plugins.amortization.newCalculation();
c.addRateChange(r, new Date(2005, 0, 1));
c.addCompoundPeriodChange(12, new Date(2005, 0, 1));
c.addLoan(2000, new Date(2005, 0, 1));
c.addPayment(500, new Date(2005, 1, 28), null, 12, 5, 31);
```

--------------------------------

### Migration file naming examples

Source: https://docs.servoy.com/reference/servoyextensions/modules/svycloudutils/svydeployutils.md

Examples of valid migration filenames using the double-underscore separator.

```bash
database-migration/V__1__my_database__initial_schema.sql
database-migration/V__2__my_database__add_users_table.sql
database-migration/R__1__my_database__refresh_views.sql
```

--------------------------------

### GET /guides/deploy.md

Source: https://docs.servoy.com/guides/deploy.md

Perform an HTTP GET request to query the documentation dynamically for specific information.

```APIDOC
## GET /guides/deploy.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.servoy.com/guides/deploy.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### Install Cypress Globally

Source: https://docs.servoy.com/reference/servoy-cloud/e2e-cypress-testing.md

Use the npm command to install the Cypress framework on your system.

```bash
npm install cypress -g
```

--------------------------------

### Implement setUp and tearDown functions

Source: https://docs.servoy.com/reference/servoy-developer/object-editors/scripting-editor/unit-tests.md

Define setUp and tearDown functions to prepare and clean up the environment before and after each individual test case.

```javascript
function setUp() {
  //Code here to setup the environment for the testcases in this scope
}
function tearDown() {
  //Code here to cleanup the environment after running the testcases in this scope
}
```

--------------------------------

### Create and execute a GET request

Source: https://docs.servoy.com/reference/servoyextensions/server-plugins/http/httpclient.md

Demonstrates initializing an HTTP client and executing a GET request. Note that SSL certificates must be in the Java trust store for HTTPS URLs.

```js
var client = plugins.http.createNewHttpClient();
var request = client.createGetRequest('http://www.servoy.com');
var response = request.executeRequest();
var httpCode = response.getStatusCode(); // httpCode 200 is ok"
var content = response.getResponseBody();
```

--------------------------------

### Create and execute a GET request

Source: https://docs.servoy.com/reference/servoyextensions/server-plugins/oauth/oauthservice.md

Shows how to create a GET request, add headers, and parse the JSON response.

```js
var getRequest = service.createGetRequest("https://api.linkedin.com/v2/me");
getRequest.addHeader("Accept", "application/json");

var response = getRequest.execute();
if (response.getCode() == 200) {
		var json = response.getAsJSON();
		application.output("Name is "+json.firstName);
	}
else
{
		application.output("ERROR http status "+response.getCode());
		application.output(response.getBody())
}
```

--------------------------------

### Example Button and Label Variants

Source: https://docs.servoy.com/guides/develop/application-design/styling-and-themes/component-variants.md

A practical example showing how to define a success button variant and a primary label variant.

```json
{
    "BtnSuccess": {
        "category": "button", 
        "displayName": "Success",
        "classes": [ "btn", "btn-success", "btn-lg", "font-weight-bold" ]   
    },
    "TxtPrimary": {
        "category": "label", 
        "displayName": "Primary",
        "classes": [ "h3", "text-uppercase", "text-primary" ]   
    }
 }
```

--------------------------------

### getViewPortPosition()

Source: https://docs.servoy.com/reference/servoyextensions/ui-components/grids/table.md

Gets the start and end positions of the visible area in the viewport.

```APIDOC
## getViewPortPosition()

### Description
Gets the start and end positions of the visible area in the viewport.

### Returns
- **Array<Number>** - An array containing two elements: the start position and the end position.
```

--------------------------------

### GET /guides/get-started.md

Source: https://docs.servoy.com/guides/get-started.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /guides/get-started.md

### Description
Perform an HTTP GET request on the current page URL to retrieve answers, excerpts, and sources from the documentation based on a specific question.

### Method
GET

### Endpoint
https://docs.servoy.com/guides/get-started.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate, specific question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /guides/get-started/create-a-solution.md

Source: https://docs.servoy.com/guides/get-started/create-a-solution.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /guides/get-started/create-a-solution.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.servoy.com/guides/get-started/create-a-solution.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Add Cron Jobs with Scheduler

Source: https://docs.servoy.com/reference/servoyextensions/server-plugins/scheduler.md

Examples of adding cron jobs with varying parameters including start and end dates.

```javascript
// see: http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/tutorial-lesson-06.html for more info
// add a job that runs every 20 minutes after the hour (0,20,40)
plugins.scheduler.addCronJob('20mins','0 0/20 * * * ?',method)
// add a job that runs every day at 23:30 between now and 5 days from now
var dateNow = new Date();
var date5Days = new Date(dateNow.getTime()+5*24*60*60*1000);
plugins.scheduler.addCronJob('23:30','0 30 23 ? * *',method,dateNow,date5Days)
```

--------------------------------

### GET /reference/servoyextensions/modules/home-6/getting-started.md

Source: https://docs.servoy.com/reference/servoyextensions/modules/home-6/getting-started.md

Queries the documentation page dynamically to retrieve answers based on a specific question and optional end goal.

```APIDOC
## GET /reference/servoyextensions/modules/home-6/getting-started.md

### Description
Queries the documentation dynamically to retrieve an answer to a specific question, optionally providing a broader goal to tailor the response.

### Method
GET

### Endpoint
https://docs.servoy.com/reference/servoyextensions/modules/home-6/getting-started.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### locate(arg, start)

Source: https://docs.servoy.com/reference/servoycore/dev-api/database-manager/qbsearchedcaseexpression.md

Creates a locate expression starting from a specific position.

```APIDOC
## locate(arg, start)

### Description
Create locate(arg, start) expression.

### Parameters
- **arg** (Object) - Required - String to locate.
- **start** (Number) - Required - Start position.

### Returns
- **QBColumn** - A QBFunction representing the locate function starting from the specified position.

### Example
```js
query.result.add(query.columns.mycol.locate('sample', 5))
```
```

--------------------------------

### Open File Dialog Examples

Source: https://docs.servoy.com/reference/servoyextensions/server-plugins/file.md

Demonstrates single file selection, multiple file selection, and the web-client callback approach for the showFileOpenDialog method.

```javascript
// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web and NG you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')
```

--------------------------------

### titlestring configuration example

Source: https://docs.servoy.com/reference/extension-dev/component_services/spec-file/property_types.md

Example of defining a titlestring property linked to a dataprovider.

```javascript
"headerTitle": {"type" : "titlestring", "for": "dp"},
"dp": { "type": "dataprovider", "forFoundset": "myFoundset", "resolveValuelist" : true}
```

--------------------------------

### Get selected index

Source: https://docs.servoy.com/reference/servoycore/dev-api/forms/runtimeform/controller.md

Gets the current record index of the current foundset.

```js
//gets the current record index in the current foundset
var current = controller.getSelectedIndex();
//sets the next record in the foundset, will be reflected in UI
controller.setSelectedIndex(current+1);
```

--------------------------------

### Create and execute an OPTIONS request

Source: https://docs.servoy.com/reference/servoyextensions/server-plugins/http/httpclient.md

Demonstrates initializing an HTTP client and retrieving allowed methods via an OPTIONS request.

```js
var client = plugins.http.createNewHttpClient();
var request = client.createOptionsRequest('http://www.servoy.com');
var methods = request.getAllowedMethods(request.executeRequest());
```

--------------------------------

### GET /guides/get-started/chapter-5.md

Source: https://docs.servoy.com/guides/get-started/chapter-5.md

Perform a query against the documentation to retrieve answers and relevant excerpts based on a specific question and optional goal.

```APIDOC
## GET /guides/get-started/chapter-5.md

### Description
Queries the documentation dynamically to retrieve answers and relevant excerpts.

### Method
GET

### Endpoint
https://docs.servoy.com/guides/get-started/chapter-5.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

--------------------------------

### nextDate()

Source: https://docs.servoy.com/reference/servoyextensions/server-plugins/amortization.md

Calculates the next date based on a start date, period, and start day.

```APIDOC
## nextDate(start_date, period, startday)

### Description
Calculates the next date based on the provided parameters.

### Parameters
- **start_date** (Date) - Required - The starting date.
- **period** (Object) - Required - The period definition.
- **startday** (Number) - Required - The starting day.

### Returns
- **Date** - The calculated next date.
```

--------------------------------

### toSpliced(start)

Source: https://docs.servoy.com/reference/servoycore/dev-api/js-lib/array.md

Returns a new array with elements removed starting from a specific index.

```APIDOC
## toSpliced(start)

### Description
A copying version of the splice method that returns a new array with elements removed starting from the provided index.

### Parameters
- **start** (Object) - Required - The index at which to start removing elements.

### Returns
- **Array** - A new array consisting of elements before the start index.
```

--------------------------------

### GET /guides/get-started/chapter-4.md

Source: https://docs.servoy.com/guides/get-started/chapter-4.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /guides/get-started/chapter-4.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically for information not explicitly present in the page.

### Method
GET

### Endpoint
https://docs.servoy.com/guides/get-started/chapter-4.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

--------------------------------

### GET /guides/deploy/server-configuration/server-settings.md

Source: https://docs.servoy.com/guides/deploy/server-configuration/server-settings.md

Queries the documentation page dynamically to retrieve answers based on a specific question and optional goal.

```APIDOC
## GET /guides/deploy/server-configuration/server-settings.md

### Description
Performs a dynamic query against the documentation page to retrieve answers, relevant excerpts, and sources.

### Method
GET

### Endpoint
https://docs.servoy.com/guides/deploy/server-configuration/server-settings.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### substr(start, length)

Source: https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string.md

Returns a substring of the string from the start index with a specified number of characters.

```APIDOC
## substr(start, length)

### Parameters
- **start** (Number) - Required - The starting index.
- **length** (Number) - Optional - The number of characters to extract.
```

--------------------------------

### GET /guides/deploy/troubleshooting.md

Source: https://docs.servoy.com/guides/deploy/troubleshooting.md

Queries the documentation dynamically by providing a question and an optional goal to receive a contextual answer.

```APIDOC
## GET /guides/deploy/troubleshooting.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question and an optional end goal.

### Method
GET

### Endpoint
https://docs.servoy.com/guides/deploy/troubleshooting.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### Locate string position with start index

Source: https://docs.servoy.com/reference/servoycore/dev-api/database-manager/qbfunctions.md

Finds the position of a substring starting from a specified index.

```js
var query = datasources.db.example_data.orders.createSelect();
query.where.add(query.columns.shipname.locate('amp', 1).eq(query.functions.locate('amp', 'Sample', 1)))
foundset.loadRecords(query);
```

--------------------------------

### plugins.headlessclient.createClient(solutionName, userName, password, args)

Source: https://docs.servoy.com/reference/servoyextensions/server-plugins/headlessclient.md

Initializes a new headless client and opens a specified solution.

```APIDOC
## createClient(solutionName, userName, password, args)

### Description
Initializes a new headless client and opens a specified solution using credentials and optional arguments for the solution's open method.

### Parameters
- **solutionName** (String) - The name of the solution to open.
- **userName** (String) - The username for authentication.
- **password** (String) - The password for authentication.
- **args** (Array) - Optional arguments for the solution's open method.
```

--------------------------------

### Initialize a Batch Processor with onSolutionOpen

Source: https://docs.servoy.com/guides/deploy/server-configuration/batch-processors.md

Uses the onSolutionOpen event to log startup arguments and register a cron job using the scheduler plugin.

```javascript
/**
 *
 * @param {String} arg startup argument part of the deeplink url with which the Client was started
 * @param {Object<Array<String>|String>} queryParams all query parameters of the deeplink url with which the Client was started, key>string if there was one value else key>Array<String>
 *
 * @properties={typeid:24,uuid:"FCB8FDF5-3A8F-4767-98C6-5CFBD20812F7"}
 */
function onSolutionOpen(arg, queryParams) {
	application.output('Batch Processor loaded with startup args' + arg, LOGGINGLEVEL.INFO);
    
	plugins.scheduler.addCronJob('myJob',arg,runJob)
}


/**
 * @properties={typeid:24,uuid:"9FC1E99C-518A-408F-952E-82493DF8F846"}
 */
function runJob(){
	
	application.output('I am doing something', LOGGINGLEVEL.INFO);
}
```

--------------------------------

### Install Requirements for Mac

Source: https://docs.servoy.com/reference/servoy-cloud/on-premise-deployment.md

Commands to install the ECR credential helper and AWS CLI on macOS.

```bash
brew install docker-credential-helper-ecr

curl https://awscli.amazonaws.com/AWSCLIV2.pkg -o AWSCLIV2.pkg

sudo installer -pkg AWSCLIV2.pkg -target /

aws configure
```

--------------------------------

### Pad String Start

Source: https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string.md

Pads the start of a string to a target length, either with spaces or a custom character.

```js
string.padStart(10);
```

```js
string.padStart(10, '*');
```

--------------------------------

### Initialize and Manage Push Notifications

Source: https://docs.servoy.com/guides/develop/programming-guide/extensions/modules/svyphonegap/push-notifications.md

Demonstrates how to generate a token, subscribe to a topic, and set up a callback for handling incoming notifications.

```javascript
//initialize and generate a notification token.
plugins.svyphonegapPush.getToken(null, null);

//subscribe to notifications where topic = svyMobile.
plugins.svyphonegapPush.subscribeToTopic(null, null, 'svyMobile')

//when receiving a notification display a message if UI is visible.
plugins.svyphonegapPush.onNotification(showMessage, null, null)

//Use a callback function to designate behavior when notification is received.
function showMessage(data) {
//if application is in background
	if (data.wasTapped) {
		plugins.dialogs.showInfoDialog('INFO', 'Notification received while UI closed.')
	} else {
//if application is active
		plugins.dialogs.showInfoDialog('INFO', 'Notification received while UI visible.')
	}
}

//Sending a message
scopes.phonegap.sendFCMPushMessage('svyMobile','INFO','This is a message','urgent_alert')
```

--------------------------------

### GET /guides/deploy/server-configuration.md

Source: https://docs.servoy.com/guides/deploy/server-configuration.md

Queries the documentation page dynamically to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /guides/deploy/server-configuration.md

### Description
Perform a dynamic query against the documentation page to retrieve answers and relevant excerpts.

### Method
GET

### Endpoint
https://docs.servoy.com/guides/deploy/server-configuration.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

--------------------------------

### Free search syntax examples

Source: https://docs.servoy.com/guides/develop/programming-guide/extensions/modules/svypopupfilter.md

Examples of search query syntax supported by the free search feature.

```text
john -smith   // matches "John Doe" and "Suxy Johnson" but not "John Smith"
+john         // matches "John Doe", but not "Suzy Johnson"
freight:>100  // matches any freight greater than $100
freight:>=100 // matches any freight greater or equal to $100
order-date:<01-01-1997  // matches any date less than 01-01-1997
order-date:<=01-01-1997  // matches any date less than or equal to 01-01-1997
order-date:01-01-1997...12-31-1997  // matches any date during the year of 1997
```

--------------------------------

### Configure Valuelist Settings

Source: https://docs.servoy.com/reference/extension-dev/component_services/spec-file/property_types.md

JSON configuration examples for valuelist properties.

```json
"lazyLoading": true
```

```json
"max": 500
```

```json
"for": "myDPProperty"
```

```json
"forFoundset": "myFoundset"
```

--------------------------------

### Install Requirements for Linux

Source: https://docs.servoy.com/reference/servoy-cloud/on-premise-deployment.md

Commands to install the ECR credential helper and AWS CLI on Linux systems.

```bash
curl "https://amazon-ecr-credential-helper-releases.s3.us-east-2.amazonaws.com/0.5.0/linux-amd64/docker-credential-ecr-login" -o docker-credential-ecr-login

chmod +x docker-credential-ecr-login

sudo mv docker-credential-ecr-login /usr/local/bin/

curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"

unzip awscliv2.zip

sudo ./aws/install

aws configure
```

--------------------------------

### GET /guides/get-started/chapter-3.md

Source: https://docs.servoy.com/guides/get-started/chapter-3.md

Queries the documentation dynamically by providing a specific question and an optional end goal to receive a tailored response.

```APIDOC
## GET https://docs.servoy.com/guides/get-started/chapter-3.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.servoy.com/guides/get-started/chapter-3.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Create and execute a HEAD request

Source: https://docs.servoy.com/reference/servoyextensions/server-plugins/http/httpclient.md

Demonstrates initializing an HTTP client and executing a HEAD request to retrieve headers.

```js
var client = plugins.http.createNewHttpClient();
var request = client.createHeadRequest('http://www.servoy.com');
var response = request.executeRequest();
var httpCode = response.getStatusCode(); // httpCode 200 is ok
var header = response.getResponseHeaders('last-modified');
```

--------------------------------

### fill(value, start, end)

Source: https://docs.servoy.com/reference/servoycore/dev-api/js-lib/array.md

Changes all elements in an array to a static value, from a start index to an end index.

```APIDOC
## fill(value, start, end)

### Description
Changes all elements in an array to a static value, from a start index (default 0) to an end index (default array.length).

### Parameters
- **value** (Object) - Value to fill the array with.
- **start** (Number) - Optional. Zero-based index at which to start filling.
- **end** (Number) - Optional. Zero-based index at which to end filling.

### Returns
- **Array** - The modified array.

### Example
```js
array.fill('test');
```
```

--------------------------------

### locate(string1, string2, start)

Source: https://docs.servoy.com/reference/servoycore/dev-api/database-manager/qbfunctions.md

Locates the first occurrence of one string in another, starting from a specific position.

```APIDOC
## locate(string1, string2, start)

### Description
Create locate(arg, start) expression.

### Parameters
- **string1** (Object) - Required - string to locate
- **string2** (Object) - Required - string to search in
- **start** (Number) - Required - start pos

### Returns
- **QBIntegerColumn** - A query builder column representing the position of the first occurrence of one string in another, starting from a given position.
```

--------------------------------

### GET /reference/servoyextensions/solutions/home/tutorial.md

Source: https://docs.servoy.com/reference/servoyextensions/solutions/home/tutorial.md

Queries the documentation dynamically by providing a question and an optional goal to receive a context-aware answer.

```APIDOC
## GET /reference/servoyextensions/solutions/home/tutorial.md

### Description
Queries the documentation dynamically to retrieve answers, relevant excerpts, and sources based on a specific question and an optional broader goal.

### Method
GET

### Endpoint
https://docs.servoy.com/reference/servoyextensions/solutions/home/tutorial.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### Create locate expression with start position

Source: https://docs.servoy.com/reference/servoycore/dev-api/database-manager/qbaggregate.md

Use the locate method with a starting position index to search for a string.

```javascript
query.result.add(query.columns.mycol.locate('sample', 5))
```

--------------------------------

### GET /guides/develop/application-design/ui-components/specialized-components/home-7.md

Source: https://docs.servoy.com/guides/develop/application-design/ui-components/specialized-components/home-7.md

Query the documentation dynamically by asking a question.

```APIDOC
## GET /guides/develop/application-design/ui-components/specialized-components/home-7.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
/guides/develop/application-design/ui-components/specialized-components/home-7.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

--------------------------------

### Install GPG on macOS

Source: https://docs.servoy.com/reference/servoy-cloud/database-backup.md

Use Homebrew to install the GPG software required for decrypting backup files on macOS.

```bash
brew install gpg
```

--------------------------------

### Check if a string starts with a specific sequence

Source: https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string.md

Determines if a string begins with the specified characters, optionally starting from a specific index.

```javascript
var str1 = 'Cats are the best!';
 application.output(str1.startsWith('Cats'));
```

```javascript
var str1 = 'Cats are the best!';
 application.output(str1.startsWith('Cats'));
```

--------------------------------

### locate(arg, start)

Source: https://docs.servoy.com/reference/servoycore/dev-api/database-manager/qbtextcolumn.md

Creates a locate expression to find the position of a string within the column, starting from a specific position.

```APIDOC
### locate(arg, start)

**Parameters**
- **arg** (Object) - String to locate.
- **start** (Number) - Start position.

**Returns**
- **QBIntegerColumn** - The QBIntegerColumn that can be added to the result.

**Example**
```js
query.result.add(query.columns.mycol.locate('sample', 5))
```
```

--------------------------------

### GET /guides/develop/application-design/ui-components/specialized-components/home-6.md

Source: https://docs.servoy.com/guides/develop/application-design/ui-components/specialized-components/home-6.md

Query the documentation dynamically by asking a question.

```APIDOC
## GET /guides/develop/application-design/ui-components/specialized-components/home-6.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
/guides/develop/application-design/ui-components/specialized-components/home-6.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask.
- **goal** (string) - Optional - The broader end goal to tailor the answer.
```

--------------------------------

### GET /guides/deploy/server-configuration/monitoring.md

Source: https://docs.servoy.com/guides/deploy/server-configuration/monitoring.md

Queries the documentation dynamically by providing a specific question and an optional goal to receive a tailored response.

```APIDOC
## GET /guides/deploy/server-configuration/monitoring.md

### Description
Perform a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.servoy.com/guides/deploy/server-configuration/monitoring.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Create a file on Linux or macOS

Source: https://docs.servoy.com/guides/develop/programming-guide/working-with-files/file-plugin.md

Examples of creating files using standard Unix-style paths for Linux and macOS environments.

```javascript
var f = plugins.file.createFile("/home/servoy/helloworld.txt");
f.createNewFile();
```

```javascript
var f = plugins.file.createFile("/Users/servoy/helloworld.txt");
f.createNewFile();
```

--------------------------------

### Create a SimpleSearch instance

Source: https://docs.servoy.com/guides/develop/programming-guide/extensions/modules/svysearch.md

Examples of initializing a SimpleSearch using different data sources such as a foundset, a record, or a database string.

```javascript
scopes.svySearch.createSimpleSearch(foundset);
scopes.svySearch.createSimpleSearch(record);
scopes.svySearch.createSimpleSearch('db:/example_data/orders');
```

--------------------------------

### setDates(eventID, start, end, options)

Source: https://docs.servoy.com/reference/servoyextensions/ui-components/visualization/fullcalendar2.md

Sets an event’s start date, end date, and allDay properties at the same time.

```APIDOC
## setDates(eventID, start, end, options)

### Description
Sets an event’s start date, end date, and allDay properties at the same time.

### Parameters
- **eventID** (String) - Required - The unique identifier of the event to modify.
- **start** (Object) - Required - The new start date for the event.
- **end** (Object) - Required - The new end date for the event.
- **options** (Object) - Optional - Optional settings for configuring how the dates are set.
```

--------------------------------

### GET /reference/servoyextensions/modules/svylookupexample.md

Source: https://docs.servoy.com/reference/servoyextensions/modules/svylookupexample.md

Queries the documentation dynamically by providing a specific question and an optional end goal.

```APIDOC
## GET /reference/servoyextensions/modules/svylookupexample.md

### Description
Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
/reference/servoyextensions/modules/svylookupexample.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation system.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.servoy.com/reference/servoycore/object-model/solution/relationitem.md

Use an HTTP GET request to query the documentation for specific information regarding the RelationItem object.

```http
GET https://docs.servoy.com/reference/servoycore/object-model/solution/relationitem.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Initialize and use a Logger

Source: https://docs.servoy.com/guides/develop/programming-guide/extensions/modules/svyutils/logmanager.md

Demonstrates how to retrieve a logger instance and log messages using different levels and string interpolation.

```javascript
var log = scopes.svyLogManager.getLogger('com.mycompany.mysolution')
log.debug("Hello, I'm debuggin'")
var name = 'you'
log.trace("Hello {}", name) //outputs "Hello you":
```

--------------------------------

### Query documentation via HTTP GET

Source: https://docs.servoy.com/guides/deploy/other-topics/running-in-an-iframe.md

Perform an HTTP GET request to the documentation URL with ask and goal parameters to retrieve dynamic information.

```http
GET https://docs.servoy.com/guides/deploy/other-topics/running-in-an-iframe.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Start a Headless Client in onSolutionOpen

Source: https://docs.servoy.com/guides/develop/programming-guide/automation-and-scheduling/headless-api.md

Initializes a headless client automatically when the solution opens to execute background tasks.

```javascript
function onSolutionOpen() {
    // Automatically create and start a headless client when the solution starts
    var headlessClient = plugins.headlessclient.createClient("mySolution", "admin", "password", null);

    if (headlessClient != null && headlessClient.isValid()) {
        // Queue a method to be executed by the headless client on startup
        headlessClient.queueMethod(null, "initializeBackgroundTasks", null);
        application.output("Headless client started and background task initialized.");
    } else {
        application.output("Failed to create the headless client.");
    }
}
```

--------------------------------

### Create a datasource with primary keys

Source: https://docs.servoy.com/reference/servoycore/dev-api/database-manager/jsdataset.md

Demonstrates creating a datasource while specifying primary key names.

```javascript
ds.addColumn('my_id'); // note: use regular javascript identifiers so they can be used in scripting
ds.addColumn('my_label');
var uri = ds.createDataSource('mydata', [JSColumn.INTEGER, JSColumn.TEXT], ['my_id']);
var jsform = solutionModel.newForm(fname, uri, null, true, 300, 300);

var query = 'select customerid, address, city, country  from customers';
var ds2 = databaseManager.getDataSetByQuery('example_data', query, null, 999);
var uri2 = ds2.createDataSource('mydata2', null, ['customerid']); // types are inferred from query result, use customerid as pk
```

--------------------------------

### startAnimate()

Source: https://docs.servoy.com/reference/servoyextensions/ui-components/visualization/canvas.md

Start animating sprites.

```APIDOC
## startAnimate()

### Description
Start animating sprites.
```

--------------------------------

### Create and Customize a Window

Source: https://docs.servoy.com/guides/develop/programming-guide/scripting-the-ui/windows-dialogs-and-popups.md

Demonstrates the full lifecycle of creating, configuring, and displaying a custom window.

```javascript
/**
 * Create and customize a window to display a form.
 */
function openCustomWindow() {
    //  Create the window with a unique name and type (e.g., a non-modal dialog)
    var win = application.createWindow('customWindow', JSWindow.DIALOG);

    //  Set the title of the window
    win.title = 'Custom Popup Window';

    //  Set the size of the window to 500px wide and 400px tall
    win.setSize(500, 400);

    //  Set the position of the window at (200px, 150px) on the screen
    win.setLocation(200, 150);

    // Set the window to be undecorated (no title bar or borders)
    win.undecorated = false;  // Set to true to hide title bar and borders if needed

    // Set the window to be non-resizable
    win.resizable = false;

    // Set the opacity to 80% (slightly transparent)
    win.opacity = 0.8;

    // Apply a custom CSS class for styling in NG Client
    win.setCSSClass('custom-popup-style');  // Use your custom CSS class for styling

    // Display the form inside the window
    win.show(forms.customForm);  // Replace 'customForm' with the form you want to display
}
```

--------------------------------

### getCookies()

Source: https://docs.servoy.com/reference/servoyextensions/server-plugins/http/httpclient.md

Get all cookies from this client.

```APIDOC
## getCookies()

### Description
Get all cookies from this client.
```

--------------------------------

### role.getName()

Source: https://docs.servoy.com/reference/servoyextensions/modules/home-6/api-documentation.md

Gets the name of this role.

```APIDOC
## role.getName()

### Description
Gets the name of this role. The role name is unique to the associated tenant.

### Returns
- **String** - The role name.
```

--------------------------------

### Create a ViewFoundSet

Source: https://docs.servoy.com/reference/servoy-developer/solution-explorer/all-solutions/active-solution/datasources/viewfoundsets-datasource.md

Initializes a ViewFoundSet object using a specified name and QBSelect query.

```javascript
databaseManager.getViewFoundSet(String name, QBSelect query)
```

--------------------------------

### Create and execute a POST request

Source: https://docs.servoy.com/reference/servoyextensions/server-plugins/http/httpclient.md

Demonstrates creating a POST request, adding parameters, setting the charset, and executing the request with credentials.

```js
var client = plugins.http.createNewHttpClient();
var poster = client.createPostRequest('https://twitter.com/statuses/update.json');
poster.addParameter('status',globals.textToPost);
poster.addParameter('source','Test Source');
poster.setCharset('UTF-8');
var httpCode = poster.executeRequest(globals.twitterUserName, globals.twitterPassword).getStatusCode(); // httpCode 200 is ok
```

--------------------------------

### getName()

Source: https://docs.servoy.com/reference/servoycore/dev-api/forms/runtimeform/controller.md

Get the name of this form.

```APIDOC
## getName()

### Description
Get the name of this form.

### Returns
- **String** - The form name.
```

--------------------------------

### duplicateFoundSet()

Source: https://docs.servoy.com/reference/servoycore/dev-api/database-manager/viewfoundset.md

Get a duplicate of the viewfoundset.

```APIDOC
## duplicateFoundSet()

### Description
Get a duplicate of the viewfoundset.

### Returns
- **JSFoundSet** - A duplicate instance of the current viewfoundset.
```

--------------------------------

### GET /guides/deploy/server-configuration/batch-processors.md

Source: https://docs.servoy.com/guides/deploy/server-configuration/batch-processors.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /guides/deploy/server-configuration/batch-processors.md

### Description
Queries the documentation dynamically to retrieve answers, relevant excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.servoy.com/guides/deploy/server-configuration/batch-processors.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### application.getClipboardString()

Source: https://docs.servoy.com/reference/servoycore/dev-api/application.md

Gets a string from the clipboard.

```APIDOC
## application.getClipboardString()

### Description
Gets a string from the clipboard, null if not a string or empty.

### Returns
- **String** The string from the clipboard
```

--------------------------------

### Create and Display a Popup Menu

Source: https://docs.servoy.com/guides/develop/programming-guide/scripting-the-ui/windows-dialogs-and-popups.md

Demonstrates initializing a popup menu, adding items with callbacks, and displaying it relative to a UI element.

```javascript
/**
 * Function to show a popup menu with options near a UI element.
 */
function showPopupMenu(event) {
    // Create a popup menu
    var popupMenu = plugins.window.createPopupMenu();
    
    // Add items to the popup menu
    popupMenu.addMenuItem('Edit', onMenuItemClick);
    popupMenu.addMenuItem('Delete', onMenuItemClick);
    popupMenu.addMenuItem('View Details', onMenuItemClick);
    
    // Show the popup menu near the clicked element (e.g., a button or a table row)
    popupMenu.show(event.getSource());
}

/**
 * Callback function to handle menu item clicks.
 */
function onMenuItemClick(menuItem) {
    var selectedItem = menuItem.text;
    application.output('Selected option: ' + selectedItem);
    
    // Perform different actions based on the selected option
    if (selectedItem === 'Edit') {
        application.output('User selected to edit the item.');
    } else if (selectedItem === 'Delete') {
        application.output('User selected to delete the item.');
    } else if (selectedItem === 'View Details') {
        application.output('User selected to view details.');
    }
}
```

--------------------------------

### GET /guides/deploy/server-configuration/monitoring/client-performance.md

Source: https://docs.servoy.com/guides/deploy/server-configuration/monitoring/client-performance.md

Queries the documentation page dynamically to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /guides/deploy/server-configuration/monitoring/client-performance.md

### Description
Performs a dynamic query against the documentation page to retrieve information not explicitly present in the static content.

### Method
GET

### Endpoint
https://docs.servoy.com/guides/deploy/server-configuration/monitoring/client-performance.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### getSelectedRecord()

Source: https://docs.servoy.com/reference/servoycore/dev-api/database-manager/jsfoundset.md

Get the selected record.

```APIDOC
## getSelectedRecord()

### Description
Get the selected record.
```

--------------------------------

### getFlags()

Source: https://docs.servoy.com/reference/servoycore/dev-api/database-manager/qbcolumn.md

Get the column flags.

```APIDOC
## getFlags()

### Description
Returns the bit pattern flags of the column (e.g., UUID_COLUMN, EXCLUDED_COLUMN, TENANT_COLUMN).

### Returns
- **Number** - An integer representing the flags of the column.
```

--------------------------------

### GET /reference/servoy-developer/object-editors/scripting-editor/getting-started.md

Source: https://docs.servoy.com/reference/servoy-developer/object-editors/scripting-editor/getting-started.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /reference/servoy-developer/object-editors/scripting-editor/getting-started.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.servoy.com/reference/servoy-developer/object-editors/scripting-editor/getting-started.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### tenant.getSlaves()

Source: https://docs.servoy.com/guides/develop/programming-guide/extensions/modules/svysecurity/api-documentation.md

Gets all slaves of this tenant.

```APIDOC
## tenant.getSlaves()

### Description
Gets all slaves of this tenant. WARNING: Cannot call this function when logged in as a user.

### Returns
- **Array<Tenant>** - Array of tenants that have this tenant as their master.
```

--------------------------------

### getStartupArguments()

Source: https://docs.servoy.com/reference/servoycore/dev-api/application.md

Retrieves the parameters provided at startup.

```APIDOC
## getStartupArguments()

### Description
Retrieves the parameters provided at startup.

### Returns
- **Array** - The startup arguments.
```

--------------------------------

### permission.getName()

Source: https://docs.servoy.com/guides/develop/programming-guide/extensions/modules/svysecurity/api-documentation.md

Gets the name of this permission.

```APIDOC
## permission.getName()

### Description
Gets the name of this permission. The permission name is unique in the system and matches a Servoy security group name.

### Returns
- **String** - The name of the permission.
```

--------------------------------

### Create ES384 Algorithm Instance

Source: https://docs.servoy.com/reference/servoyextensions/server-plugins/jwt.md

Examples for creating an ES384 algorithm instance using either a public key or both public and private keys.

```javascript
plugins.jwt.ES384('MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEEV....')
     .kid('2X9R4H....')
```

```javascript
plugins.jwt.ES384.publicKey('MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEEV....', 'MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wa...')
     .kid('2X9R4H....')
```

--------------------------------

### getWidth()

Source: https://docs.servoy.com/guides/develop/programming-guide/jasperreports/jasperreportsservoyviewer.md

Gets the width of the Bean.

```APIDOC
## getWidth()

### Description
Gets the width of the Bean.

### Returns
- **Number** - The width of the Bean.

### Example
```js
var w = myElement.getWidth();
```
```

--------------------------------

### Create a new table and columns

Source: https://docs.servoy.com/reference/servoyextensions/server-plugins/maintenance/jstableobject.md

Demonstrates creating a new table and defining various column types, including primary keys and UUIDs, before synchronizing with the database.

```javascript
var server = plugins.maintenance.getServer("example_data");
if (server)
{
	var table = server.createNewTable("users");
	if (table)
	{
		var pk = table.createNewColumn("id", JSColumn.MEDIA, 16); // can also use (JSColumn.TEXT, 36) for UUIDs
		pk.rowIdentifierType = JSColumn.PK_COLUMN;
		pk.setFlag(JSColumn.UUID_COLUMN, true)
		pk.sequenceType = JSColumn.UUID_GENERATOR
		var c = table.createNewColumn("name", JSColumn.TEXT, 100);
		c.allowNull = false
		table.createNewColumn("age", JSColumn.INTEGER, 0);
		table.createNewColumn("last_login", JSColumn.DATETIME, 0);
		var result = server.synchronizeWithDB(table);
		if (result) application.output("Table successfully created.");
		else application.output("Table not created.");
	}
}
```

```javascript
var server = plugins.maintenance.getServer("example_data");
if (server)
{
	var table = server.createNewTable("users");
	if (table)
	{
		var pk = table.createNewColumn("id", JSColumn.MEDIA, 16); // can also use (JSColumn.TEXT, 36) for UUIDs
		pk.rowIdentifierType = JSColumn.PK_COLUMN;
		pk.setFlag(JSColumn.UUID_COLUMN, true)
		pk.sequenceType = JSColumn.UUID_GENERATOR
		var c = table.createNewColumn("name", JSColumn.TEXT, 100);
		c.allowNull = false
		table.createNewColumn("age", JSColumn.INTEGER, 0);
		table.createNewColumn("last_login", JSColumn.DATETIME, 0);
		var result = server.synchronizeWithDB(table);
		if (result) application.output("Table successfully created.");
		else application.output("Table not created.");
	}
}
```

--------------------------------

### getHeight()

Source: https://docs.servoy.com/guides/develop/programming-guide/jasperreports/jasperreportsservoyviewer.md

Gets the height of the Bean.

```APIDOC
## getHeight()

### Description
Gets the height of the Bean.

### Returns
- **Number** - The height of the Bean.

### Example
```js
var h = myElement.getHeight();
```
```

--------------------------------

### Start Cypress

Source: https://docs.servoy.com/reference/servoy-cloud/e2e-cypress-testing/using-cypress.md

Command to launch the Cypress test runner interface.

```bash
npx cypress open
```

--------------------------------

### startTransaction()

Source: https://docs.servoy.com/reference/servoycore/dev-api/database-manager.md

Starts a new database transaction.

```APIDOC
## startTransaction()

### Description
Start a database transaction.
```

--------------------------------

### GET /guides/readme_overview.md

Source: https://docs.servoy.com/guides/readme_overview.md

Performs a dynamic query against the documentation to retrieve answers and relevant excerpts based on a specific question and optional goal.

```APIDOC
## GET /guides/readme_overview.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present in the current page.

### Method
GET

### Endpoint
https://docs.servoy.com/guides/readme_overview.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

--------------------------------

### session.getStart()

Source: https://docs.servoy.com/guides/develop/programming-guide/extensions/modules/svysecurity/api-documentation.md

Retrieves the start datetime of the session.

```APIDOC
## session.getStart()

### Description
Gets the start date/time of this session, which is set upon user login.

### Returns
- **Date** - The start date/time of this session.
```

--------------------------------

### getView()

Source: https://docs.servoy.com/reference/servoyextensions/ui-components/visualization/fullcalendar2.md

Gets the current view object.

```APIDOC
### getView()

**Description:** Gets the View Object for the current view.

**Returns:** ViewType - The view object representing the currently active calendar view.
```

--------------------------------

### GET /guides/deploy/other-topics.md

Source: https://docs.servoy.com/guides/deploy/other-topics.md

Queries the documentation dynamically by providing a question and an optional goal to receive a tailored answer with relevant excerpts.

```APIDOC
## GET /guides/deploy/other-topics.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question and an optional broader goal.

### Method
GET

### Endpoint
https://docs.servoy.com/guides/deploy/other-topics.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```
Tokens:
Raw