OpenRefine

https://openrefine.org/docs
Admin
OpenRefine is a powerful, open-source data cleaning and transformation tool that allows users to...
Tokens:69,257
Snippets:1,004
Trust Score:9.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Resolved OpenRefine Installer URL Example

Source: https://openrefine.org/docs/technical-reference/homebrew-cask-process

An example of the final URL generated for version 3.4.1.

```text
https://github.com/OpenRefine/OpenRefine/releases/download/3.4.1/openrefine-mac-3.4.1.dmg  
```

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

### Homebrew Installation Output

Source: https://openrefine.org/docs/manual/installing

Example of the terminal output displayed after successfully running the Homebrew install command.

```text
==> Downloading https://github.com/OpenRefine/OpenRefine/releases/download/3.4.1/openrefine-mac-3.4.1.dmg  
######################################################################## 100.0%  
==> Installing Cask openrefine  
==> Moving App 'OpenRefine.app' to '/Applications/OpenRefine.app'  
🍺  openrefine was successfully installed!  
```

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

### Install Cypress and Dependencies

Source: https://openrefine.org/docs/technical-reference/functional-tests

Navigate to the Cypress test directory and install necessary dependencies using Yarn. Ensure Node.js version 20.x or higher is installed.

```bash
cd ./main/tests/cypress
yarn install
```

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

### Start OpenRefine Server

Source: https://openrefine.org/docs/technical-reference/functional-tests

Change directory to the top-level folder and start the OpenRefine server. This is a prerequisite for running Cypress tests.

```bash
cd ../../..
./refine
```

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

### Run OpenRefine with Extension Installed for Testing

Source: https://openrefine.org/docs/technical-reference/writing-extensions

Use this command to start an OpenRefine instance with your extension loaded, enabling it to be tested by Cypress. Ensure your extension is in an 'extensions' subdirectory relative to the specified REFINE_DATA_DIR.

```bash
# note: your extension should be in a directory called "extensions" within this directory  
REFINE_DATA_DIR=/path/to/your/test/directory ./refine  

```

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

### Install JDK on Linux

Source: https://openrefine.org/docs/technical-reference/build-test-run

Commands to install the default JDK using various Linux package managers.

```bash
sudo apt install default-jdk  
```

```bash
sudo dnf install java-devel  
```

```bash
sudo pacman -S jdk-openjdk  
```

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

### Run OpenRefine from Terminal (Linux/macOS)

Source: https://openrefine.org/docs/manual/running

Use this command in the terminal to start OpenRefine after navigating to its installation directory. Ensure you have a JDK installed and JAVA_HOME configured.

```bash
cd openrefine-3.4.1
  ./refine
```

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

### Build OpenRefine distributions

Source: https://openrefine.org/docs/technical-reference/build-test-run

Creates installation packages for supported operating systems using Maven.

```bash
./refine dist <version>  

```

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

### Get Project Models Response

Source: https://openrefine.org/docs/technical-reference/openrefine-api

Example JSON response structure returned by the get-models command, detailing column, record, and scripting models.

```json
{
   "columnModel":{
      "columns":[
         {
            "cellIndex":0,
            "originalName":"email",
            "name":"email"
         },
         {
            "cellIndex":1,
            "originalName":"name",
            "name":"name"
         },
         {
            "cellIndex":2,
            "originalName":"state",
            "name":"state"
         },
         {
            "cellIndex":3,
            "originalName":"gender",
            "name":"gender"
         },
         {
            "cellIndex":4,
            "originalName":"purchase",
            "name":"purchase"
         }
      ],
      "keyCellIndex":0,
      "keyColumnName":"email",
      "columnGroups":[

      ]
   },
   "recordModel":{
      "hasRecords":false
   },
   "overlayModels":{

   },
   "scripting":{
      "grel":{
         "name":"General Refine Expression Language (GREL)",
         "defaultExpression":"value"
      },
      "jython":{
         "name":"Python / Jython",
         "defaultExpression":"return value"
      },
      "clojure":{
         "name":"Clojure",
         "defaultExpression":"value"
      }
   }
}
```

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

### Run OpenRefine from command line

Source: https://openrefine.org/docs/technical-reference/build-test-run

Starts the OpenRefine application using the shell script.

```bash
./refine -d /tmp/openrefine_workspace
```

```bash
./refine  

```

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

### Verify Node.js and npm versions

Source: https://openrefine.org/docs/technical-reference/build-test-run

Check the installed versions of Node.js and npm.

```bash
node -v  
npm -v  
```

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

### Run Cypress tests

Source: https://openrefine.org/docs/technical-reference/build-test-run

Starts the Cypress test runner for the client-side UI.

```bash
yarn --cwd ./main/tests/cypress run cypress open
```

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

### OpenRefine Installer URL Formula

Source: https://openrefine.org/docs/technical-reference/homebrew-cask-process

The formula used by the Homebrew cask to locate the OpenRefine installer DMG file.

```text
https://github.com/OpenRefine/OpenRefine/releases/download/#{version}/openrefine-mac-#{version}.dmg  
```

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

### Install OpenRefine via Homebrew

Source: https://openrefine.org/docs/manual/installing

Use this command in the terminal to install OpenRefine on macOS using the Homebrew package manager.

```bash
brew install --cask openrefine  
```

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

### OAuth Configuration

Source: https://openrefine.org/docs/manual/wikibase/configuration

Configuration for OAuth if the extension is installed.

```APIDOC
## OAuth Configuration

### Parameters

#### `oauth` (object) - Optional

Not required. Should be configured if the Wikibase has the OAuth extension installed.

##### `registration_page` (string) - Required within `oauth`

The page to register an OAuth consumer of the Wikibase. Typically in the form "https://foo.bar/wiki/Special:OAuthConsumerRegistration/propose".
```

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

### Windows Command-Line Options

Source: https://openrefine.org/docs/manual/running

Use these commands to start OpenRefine with specific configurations on Windows. The `/i` flag sets the IP address and port, while `/p` sets only the port.

```bash
C:>refine /i 127.0.0.2 /p 3334
```

```bash
refine /?
```

```bash
refine /w /path/to/openrefine
```

```bash
refine /m 6000M
```

```bash
refine /p 3334
```

```bash
refine /i 127.0.0.2:3334
```

```bash
refine /H openrefine.internal
```

```bash
refine /d /where/you/want/the/workspace
```

```bash
refine /v info
```

```bash
refine /x refine.autosave=5
```

```bash
refine /x refine.data_dir=/
```

```bash
refine /x refine.development=false
```

```bash
refine /x refine.headless=false
```

```bash
refine /x refine.host=127.0.0.1
```

```bash
refine /x refine.port=3333
```

```bash
refine /x refine.webapp=main/webapp
```

```bash
refine /x refine.display.new.version.notice=true
```

```bash
refine /d
```

```bash
refine /x
```

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

### Switch from Dev to Stable Cask

Source: https://openrefine.org/docs/manual/installing

Uninstall the development version and install the stable release using Homebrew.

```bash
brew uninstall --cask openrefine-dev  
brew install --cask openrefine  
```

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

### Configure MAVEN_HOME environment variable

Source: https://openrefine.org/docs/technical-reference/build-test-run

Set the MAVEN_HOME environment variable to point to the Maven installation directory.

```bash
MAVEN_HOME=E:\Downloads\apache-maven-3.8.4-bin\apache-maven-3.8.4\  
```

```bash
MAVEN_HOME=/opt/apache-maven-3.8.7  
```

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

### Homebrew Uninstallation Output

Source: https://openrefine.org/docs/manual/installing

Example of the terminal output displayed after successfully running the Homebrew uninstall command.

```text
==> Uninstalling Cask openrefine  
==> Backing App 'OpenRefine.app' up to '/usr/local/Caskroom/openrefine/3.4.1/OpenRefine.app'  
==> Removing App '/Applications/OpenRefine.app'  
==> Purging files for version 3.4.1 of Cask openrefine  
```

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

### Basic Arithmetic Expressions

Source: https://openrefine.org/docs/manual/grelfunctions

Examples of integer and floating-point division behavior in OpenRefine expressions.

```OpenRefine Expression
1 / 2
```

```OpenRefine Expression
1 / 2.0
```

```OpenRefine Expression
1.0 / 2
```

```OpenRefine Expression
1.0 * x / y
```

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

### Launch OpenRefine with Custom Workspace

Source: https://openrefine.org/docs/manual/installing

Start the application from the terminal while specifying a custom workspace directory using the -d flag.

```bash
 ./refine -p 3333 -i 0.0.0.0 -m 6000M -d /My/Desired/Folder  
```

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

### Example Wikitext Structure

Source: https://openrefine.org/docs/manual/wikibase/overview

A sample of Wikitext describing an image, including metadata like description, source, author, and categories.

```text
== {{int:filedesc}} ==  
{{Information  
|Description={{en|1=Illustration from "The little folks of animal land". Inscription below image: "The Bufkins Twins Were Swinging"}}  
{{ru|1=Фотография [[:w:ru:Фрис, Гарри Виттер|Гарри Виттера Фриса]] из книги «Маленький народец страны зверят» (The little folks of animal land). Подпись под картинкой: «Близнецы Бафкинс качаются» («The Bufkins Twins Were Swinging»)}}  
|Source={{cite book |author=Harry Whittier Frees |year=1915 |title=The little folks of animal land |publisher=Lothrop, Lee & Shepard co. |pages=25| url=https://books.google.com/books?id=HcwTIRt2FvwC&pg=PA25}} Retrieved from Google Books.  
|Author=[[:w:Harry Whittier Frees|Harry Whittier Frees]]  
|Date=1915  
|Permission={{PD-US}}  
|other_versions=  
}}  
  
[[Category:Photographs of kittens by Harry Whittier Frees]]  
[[Category:Cats with objects]]
```

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

### Wikibase Constraints Configuration

Source: https://openrefine.org/docs/manual/wikibase/configuration

Configuration for Wikibase constraints if the extension is installed.

```APIDOC
## Wikibase Constraints Configuration

### Parameters

#### `constraints` (object) - Optional

Not required. Should be configured if the Wikibase has the WikibaseQualityConstraints extension installed. Configurations of constraints consists of IDs of constraints related properties and items. For Wikidata, these IDs are retrieved from extension.json. To configure this for another Wikibase instance, you should contact an admin of the Wikibase instance to get the content of `extension.json`.
```

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

### Default JVM Options in Info.plist

Source: https://openrefine.org/docs/manual/running

Example of default JVM options array in an Info.plist file, including memory settings and OpenRefine specific properties.

```xml
<key>JVMOptions</key>
<array>
<string>-Xms256M</string>
<string>-Xmx1024M</string>
<string>-Drefine.version=3.8.4</string>
<string>-Drefine.webapp=$APP_ROOT/Contents/Resource/webapp</string>
</array>

```

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

### Define a simple localized string in JSON

Source: https://openrefine.org/docs/technical-reference/translating-ui

Example of a basic key-value pair in a translation-xx.json file.

```json
{
    "name": "Français",
    "core-index/help": "Aide",
    (… more lines)
}
```

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

### GET /command/core/get-all-project-metadata

Source: https://openrefine.org/docs/technical-reference/openrefine-api

Recovers metadata for all projects, including ID, name, creation, and modification times.

```APIDOC
## GET /command/core/get-all-project-metadata

### Description
Recovers the meta data for all projects. This includes the project's id, name, time of creation and last time of modification.

### Method
GET

### Endpoint
/command/core/get-all-project-metadata

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **projects** (object) - An object containing metadata for each project.
  - **[project_id]** (object) - Metadata for a specific project.
    - **name** (string) - The name of the project.
    - **created** (string) - The creation timestamp of the project.
    - **modified** (string) - The last modification timestamp of the project.

### Response Example
```json
{
    "projects":{
        "[project_id]":{
            "name":"[project_name]",
            "created":"[project_creation_time]",
            "modified":"[project_modification_time]"
        },
        ...[More projects]...
    }
}
```
```

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

### Jython Expression Syntax

Source: https://openrefine.org/docs/manual/jythonclojure

Basic syntax examples for Jython expressions in OpenRefine, requiring a return statement.

```python
  return value[1:-1]  
```

```python
  return rowIndex%2  
```

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

### Clojure Expression Examples

Source: https://openrefine.org/docs/manual/jythonclojure

Basic syntax for Clojure expressions, utilizing available variables like value.

```clojure
(.. value (toUpperCase) )  
```

```clojure
(-> value (str/split #" ") last )  
```

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

### Set memory via command line for Linux

Source: https://openrefine.org/docs/manual/installing

Pass the -m parameter when starting the refine script from the terminal.

```bash
./refine -m 2048m  

```

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

### Define a localized string with pluralization

Source: https://openrefine.org/docs/technical-reference/translating-ui

Example using the {{plural:$2|page|pages}} syntax to handle singular and plural forms based on a parameter.

```json
"core-views/goto-page": "$1 de $2 {{plural:$2|page|pages}}"
```

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

### Configure Butterfly module path via command line

Source: https://openrefine.org/docs/technical-reference/writing-extensions

Override the default module path by specifying the property on the command line when starting OpenRefine.

```bash
-Dbutterfly.modules.path=modules,../../extensions,/path/to/your/extension
```

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

### Get All Projects Metadata Response

Source: https://openrefine.org/docs/technical-reference/openrefine-api

Response structure for retrieving metadata of all projects. It includes project ID, name, creation, and modification times.

```json
{
    "projects":{
        "[project_id]":{
            "name":"[project_name]",
            "created":"[project_creation_time]",
            "modified":"[project_modification_time]"
        },
        ...[More projects]...
    }
}
```

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

### Clone and navigate to the documentation repository

Source: https://openrefine.org/docs/technical-reference/documentation-contributions

Use these commands to download a local copy of the documentation repository and enter the directory.

```bash
git clone git@github.com:<myaccount>/openrefine.org.git  
cd openrefine.org  

```

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

### Get Array Elements

Source: https://openrefine.org/docs/manual/grelfunctions

Returns a sub-array from a start index up to (but not including) an optional end index. If the end index is omitted, returns a single element as a string. Array indices start at 0.

```javascript
value.get(2, 999)
```

```javascript
with(value, a, a.get(1, a.length()))
```

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

### Build OpenRefine from source

Source: https://openrefine.org/docs/technical-reference/build-test-run

Commands to clean and build the OpenRefine application.

```bash
./refine clean  
./refine build  
```

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

### Display OpenRefine build help

Source: https://openrefine.org/docs/technical-reference/build-test-run

View supported functions of the OpenRefine build system.

```bash
./refine -h  
```

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

### Mac/Linux Command-Line Options

Source: https://openrefine.org/docs/manual/running

Use these commands to start OpenRefine with specific configurations on Mac and Linux. The `-h` flag displays all options. Use `-k` to add a Google API key.

```bash
./refine -h
```

```bash
./refine -w /path/to/openrefine
```

```bash
./refine -d /where/you/want/the/workspace
```

```bash
./refine -m 6000M
```

```bash
./refine -p 3334
```

```bash
./refine -i 127.0.0.2:3334
```

```bash
./refine -H openrefine.internal
```

```bash
./refine -k YOUR_API_KEY
```

```bash
./refine -v info
```

```bash
./refine -x refine.autosave=5
```

```bash
./refine -x refine.data_dir=/
```

```bash
./refine -x refine.development=false
```

```bash
./refine -x refine.headless=false
```

```bash
./refine -x refine.host=127.0.0.1
```

```bash
./refine -x refine.port=3333
```

```bash
./refine -x refine.webapp=main/webapp
```

```bash
./refine -x refine.display.new.version.notice=true
```

```bash
./refine --debug
```

```bash
./refine --jmx
```

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

### Slice Array

Source: https://openrefine.org/docs/manual/grelfunctions

Returns a sub-array from a start index up to (but not including) an optional end index. Array indices start at 0.

```javascript
[0, 1, 2, 3, 4].slice(1, 3)
```

```javascript
[0, 1, 2, 3, 4].slice(2)
```

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

### Sample Extension Directory Layout

Source: https://openrefine.org/docs/technical-reference/writing-extensions

Illustrates the standard directory structure for an OpenRefine extension, including source code, module configuration, and client-side assets.

```plaintext
sample-extension/
      pom.xml (Maven configuration file)
      src/
          main/java/
              com/google/refine/sampleExtension/
                  ... Java source code ...
          test/java/
              com/google/refine/sampleExtension/
                  ... Java test files ...
      module/
          MOD-INF/
              module.properties (module settings)
              controller.js (module init and routing logic in Javascript)
          lib/
              ... Java jars ...
          ... velocity templates (.vt) ...
          ... .css files ...
          ... client-side files (.html, .css, .js, image files) ...


```

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

### Load and Visit OpenRefine Project with Fixture

Source: https://openrefine.org/docs/technical-reference/functional-tests

Use this utility to create a fresh OpenRefine project with a custom dataset provided as an array. The first row defines column names, and subsequent rows contain values.

```javascript
const fixture = [
  ['Column A', 'Column B', 'Column C'],
  ['0A', '0B', '0C'],
  ['1A', '1B', '1C'],
  ['2A', '2B', '2C'],
];
cy.loadAndVisitProject(fixture);
```

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

### GET /command/core/get-processes

Source: https://openrefine.org/docs/technical-reference/openrefine-api

Retrieves the status of asynchronous processes running on a project.

```APIDOC
## GET /command/core/get-processes

### Description
Retrieves the status of asynchronous processes running on a project.

### Method
GET

### Endpoint
/command/core/get-processes

### Parameters
#### Path Parameters
None

#### Query Parameters
- **project** (string) - Required - Project ID

#### Request Body
None

### Response
Returns JSON response with the status of asynchronous processes.
```

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

### Verify JAVA_HOME configuration

Source: https://openrefine.org/docs/technical-reference/build-test-run

Use this command to verify that the JAVA_HOME environment variable is correctly configured.

```bash
$JAVA_HOME/bin/java --version  
```

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

### Run Linting from Command Line

Source: https://openrefine.org/docs/technical-reference/build-test-run

Execute this command to automatically format the code according to project standards.

```bash
./refine lint
```

```batch
refine.bat lint
```

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

### String Starts With Check

Source: https://openrefine.org/docs/manual/grelfunctions

Checks if a string begins with a specified substring. Returns a boolean.

```GREL
"food".startsWith("foo")
```

```GREL
"food".startsWith("bar")
```

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

### Update OpenRefine via Homebrew

Source: https://openrefine.org/docs/manual/installing

Use these commands to update an existing Homebrew installation of OpenRefine.

```bash
brew update  
brew upgrade  
```

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

### Navigate and Extract OpenRefine on Linux

Source: https://openrefine.org/docs/manual/installing

Commands to navigate to the download directory, extract the archive, and launch the application.

```bash
user@machine:~$ cd Downloads/  
```

```bash
user@machine:~/Downloads$ tar xzf openrefine-3.6.2-linux.tar.gz  
```

```bash
user@machine:~/Downloads$ cd openrefine-3.6.2  
```

```bash
user@machine:~/Downloads/openrefine-3.6.2$ ./refine  
```

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

### Get Array Length

Source: https://openrefine.org/docs/manual/grelfunctions

Returns the number of items in an array. Returns 0 for an empty array.

```javascript
length(myArray)
```

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

### General Wikibase Configuration

Source: https://openrefine.org/docs/manual/wikibase/configuration

General settings for connecting to a Wikibase instance.

```APIDOC
## General Wikibase Configuration

### Parameters

#### `site_iri` (string) - Required

The IRI of the Wikibase, in the form 'http://foo.bar/entity/'. This should match the IRI prefixes used in RDF serialization. Be careful about using "http" or "https", because any variation will break comparisons at various places. The trailing slash cannot be omitted.

#### `maxlag` (integer) - Optional

Maxlag is a parameter that controls how aggressive a mass-editing tool should be when uploading edits to a Wikibase instance. See https://www.mediawiki.org/wiki/Manual:Maxlag_parameter for more details. The value should be adapted according to the actual traffic of the Wikibase.

#### `tag` (string) - Optional

Specifies a tag which should be applied to all edits made via the tool. The `${version}` variable will be replaced by the "major.minor" OpenRefine version before making edits.

#### `max_edits_per_minute` (integer) - Optional

Determines the editing speed expressed as the maximum number of edits to perform per minute, as an integer. The editing can still be slower than this rate if the performance of the Wikibase instance degrades. If set to 0, this will disable this cap.
```

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

### Define a parameterized localized string

Source: https://openrefine.org/docs/technical-reference/translating-ui

Example of a string containing a substitution variable $1 for dynamic content.

```json
"core-facets/edit-facet-title": "Cliquez ici pour éditer le nom de la facette
Colonne : $1",
```

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

### Project Creation Redirect URL

Source: https://openrefine.org/docs/technical-reference/openrefine-api

The URL format returned upon successful project creation, containing the project ID.

```text
      http://127.0.0.1:3333/project?project=<project id>  
```

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

### Conditional Logic in Jython

Source: https://openrefine.org/docs/manual/jythonclojure

Example of handling null values using conditional logic in a Jython expression.

```python
  if value is not None:  
    return value.lower()  
  else:  
    return None  
```

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

### Split string values using GREL and Jython

Source: https://openrefine.org/docs/manual/expressions

Demonstrates the syntax difference between GREL and Jython for splitting a string by a space character.

```GREL
value.split(" ")[1]
```

```Jython
return value.split(" ")[1]
```

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

### Manifest Format Check

Source: https://openrefine.org/docs/manual/wikibase/configuration

Guidance on checking the format of the manifest file.

```APIDOC
## Manifest Format Check

As mentioned above, the manifest should be in the format specified by wikibase-manifest-schema-v2.json. You can check the format by adding the manifest directly to OpenRefine, and OpenRefine will complain if there is anything wrong with the format.
```

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

### Extending the Main Menu

Source: https://openrefine.org/docs/technical-reference/writing-extensions

This section explains how to add, insert before, or insert after menu items and submenus in the main menu bar using `MenuBar.appendTo`, `MenuBar.insertBefore`, and `MenuBar.insertAfter`.

```APIDOC
## Extending the Main Menu

### Description
Allows extensions to add new menu items or submenus to the main menu bar, or to insert them relative to existing menu items.

### Method
`MenuBar.appendTo(targetMenuPath, newMenuItems)`
`MenuBar.insertBefore(targetMenuPath, newMenuItems)`
`MenuBar.insertAfter(targetMenuPath, newMenuItems)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **targetMenuPath** (Array<string>) - Required - An array of strings identifying the path to an existing menu item or submenu.
- **newMenuItems** (Array<object> | object) - Required - A single menu item/submenu object or an array of menu item/submenu objects to add.
  - Each menu item object can have:
    - **label** (string) - The text to display for the menu item.
    - **click** (function) - The function to execute when the menu item is clicked.
    - An empty object `{}` can be used to represent a menu separator.

### Request Example
```javascript
MenuBar.insertBefore(
        ["core/project", "core/export", "core/export-templating"],
        [
            {
                "label":"Menu item 1",
                "click": function() { /* ... */ }
            },
            {
                "label":"Menu item 2",
                "click": function() { /* ... */ }
            },
            {}
        ]
    );
```

### Response
N/A (This is a client-side UI modification)

### Error Handling
N/A
```

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

### Uninstall OpenRefine via Homebrew

Source: https://openrefine.org/docs/manual/installing

Use this command in the terminal to remove an existing OpenRefine installation managed by Homebrew.

```bash
brew uninstall --cask openrefine  
```

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

### Configure Data Directory in openrefine.l4j.ini

Source: https://openrefine.org/docs/manual/installing

Set a custom workspace directory by modifying the configuration file. Use quotes if the path contains spaces.

```ini
-Drefine.data_dir=D:\MyDesiredFolder  
```

```ini
-Drefine.data_dir="D:\My Desired Folder"  
```

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

### Boolean NOT Operation Example

Source: https://openrefine.org/docs/manual/grelfunctions

Demonstrates the use of the `not` function to invert a boolean statement. Returns true if the condition is false.

```GREL
not(1 > 7)
```

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

### Cypress Element Selection and Assertion

Source: https://openrefine.org/docs/technical-reference/functional-tests

Examples of basic Cypress commands for selecting DOM elements using CSS selectors and performing assertions. `cy.get` retrieves an element, `cy.click` simulates a click, and `cy.should` asserts conditions.

```javascript
cy.get('a.my-class')
```

```javascript
cy.click()
```

```javascript
cy.should('to.contains', 'my text')
```

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

### Get Project Models

Source: https://openrefine.org/docs/technical-reference/openrefine-api

Recovers the models for a specific OpenRefine project, including columns, records, and scripting languages.

```APIDOC
## GET /command/core/get-models

### Description
Retrieves the data models for a specified project, including column structure, record information, and available scripting languages.

### Method
GET

### Endpoint
/command/core/get-models

### Parameters
#### Query Parameters
- **project** (string) - Required - The ID of the project.

### Response
#### Success Response (200)
- **columnModel** (object) - Contains information about the project's columns.
- **recordModel** (object) - Contains information about records in the project.
- **overlayModels** (object) - Contains overlay models.
- **scripting** (object) - Contains details about available scripting languages (GREL, Jython, Clojure).

### Response Example
```json
{
  "columnModel": {
    "columns": [
      {
        "cellIndex": 0,
        "originalName": "email",
        "name": "email"
      },
      {
        "cellIndex": 1,
        "originalName": "name",
        "name": "name"
      },
      {
        "cellIndex": 2,
        "originalName": "state",
        "name": "state"
      },
      {
        "cellIndex": 3,
        "originalName": "gender",
        "name": "gender"
      },
      {
        "cellIndex": 4,
        "originalName": "purchase",
        "name": "purchase"
      }
    ],
    "keyCellIndex": 0,
    "keyColumnName": "email",
    "columnGroups": []
  },
  "recordModel": {
    "hasRecords": false
  },
  "overlayModels": {},
  "scripting": {
    "grel": {
      "name": "General Refine Expression Language (GREL)",
      "defaultExpression": "value"
    },
    "jython": {
      "name": "Python / Jython",
      "defaultExpression": "return value"
    },
    "clojure": {
      "name": "Clojure",
      "defaultExpression": "value"
    }
  }
}
```
```

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

### Read JVM Options from Info.plist

Source: https://openrefine.org/docs/manual/running

Use the 'defaults read' command in the Terminal to view the JVM options configured in the Info.plist file.

```bash
export OR_INFO="/Applications/OpenRefine.app/Contents/Info.plist"
defaults read $OR_INFO JVMOptions

```

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

### Apply transformation to column values

Source: https://openrefine.org/docs/manual/expressions

Example of using a GREL expression to extract the last name from a full name string.

```GREL
 value.split(" ")[1]  
```

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

### Add JVM Preferences to Info.plist

Source: https://openrefine.org/docs/manual/running

Add new JVM preference strings to the existing array in Info.plist to configure OpenRefine settings.

```xml
<key>JVMOptions</key>
<array>
<string>-Xms256M</string>
<string>-Xmx1024M</string>
<string>-Drefine.version=3.8.4</string>
<string>-Drefine.webapp=$APP_ROOT/Contents/Resource/webapp</string>
<string>-Drefine.autosave=2</string>
<string>-Dhttp.proxyHost=yourproxyhost</string>
<string>-Dhttp.proxyPort=8080</string>
<string>-Drefine.host=mymachine.local</string>
<string>-Drefine.interface=192.168.0.10</string>
<string>-Drefine.port=3333</string>
<string>-Dext.gdata.clientid=000000000000-********************************.apps.googleusercontent.com</string>
<string>-Dext.gdata.clientsecret=************************</string>
<string>-Dext.gdata.apikey=***************************************</string>
</array>

```

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

### Boolean AND Operation Example

Source: https://openrefine.org/docs/manual/grelfunctions

Demonstrates the use of the `and` function to evaluate multiple boolean statements. Returns true only if all conditions are true.

```GREL
(1 < 3).and(1 < 0)
```

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

### Set Multiple JVM Preferences in refine.ini

Source: https://openrefine.org/docs/manual/running

Configure multiple JVM preferences on a single line in refine.ini by prefixing with JAVA_OPTIONS=.

```ini
JAVA_OPTIONS=-Drefine.data_dir=C:\Users\user\Documents\OpenRefine\ -Drefine.port=3334
  

```

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

### Arithmetic Operators in GREL

Source: https://openrefine.org/docs/manual/grel

Examples of modulus and multiplication operations, noting that floating-point promotion occurs when at least one operand is a float.

```GREL
1 % 2
```

```GREL
1.0 % 2
```

```GREL
1 * 2
```

```GREL
3.5 * 2
```
Tokens:
Raw