### Start Flowable Leap Offline Installation (Shell)

Source: https://documentation.flowable.com/latest/howto/howto/howto-migration

Command to start the Flowable Leap web application from a downloaded JAR file. Requires a Java Runtime Environment to be installed.

```shell
java -jar flowable-leap.jar
```

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

### POST /runtime/process-instances

Source: https://documentation.flowable.com/latest/assets/core-swagger/bpmn.html

Start a new process instance.

```APIDOC
## POST /runtime/process-instances

### Description
Start a process instance.

### Method
POST

### Endpoint
/runtime/process-instances
```

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

### GET /runtime/process-instances

Source: https://documentation.flowable.com/latest/assets/core-swagger/bpmn.html

Retrieve a list of process instances.

```APIDOC
## GET /runtime/process-instances

### Description
List process instances.

### Method
GET

### Endpoint
/runtime/process-instances
```

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

### Resolved Network Request URL Examples

Source: https://documentation.flowable.com/latest/reactmodel/forms/concept/form-expressions

Examples of how resolved URLs appear in network requests based on configuration and server context.

```text
http://your-server-hostname/flowable-work/platform-api/search/work-instances?size=10&start=0  
```

```text
http://your-server-hostname/work/platform-api/search/work-instances?size=10&start=0  
```

```text
http://your-server-hostname/platform-api/search/work-instances?size=10&start=0  
```

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

### Install TypeScript React types

Source: https://documentation.flowable.com/latest/develop/fe/forms/start-installation

Command to install React type definitions as a development dependency for TypeScript projects using Flowable Forms.

```shell
yarn add @types/react --dev
```

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

### Install Flowable Forms and Work components

Source: https://documentation.flowable.com/latest/develop/fe/forms/start-installation

Commands to install the core Flowable Forms package and the optional Work components package. These packages are hosted in an internal repository and require configured credentials.

```shell
yarn add @flowable/forms
```

```shell
yarn add @flowable/forms-work
```

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

### Install Flowable RPA Framework Client using pip

Source: https://documentation.flowable.com/latest/develop/external-clients/rpaframework/introduction

This command installs the core Flowable RPA Framework client library using the Python package manager pip. Ensure pip is available in your environment.

```bash
pip install flowable.rpaframework-client
```

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

### Get Start of Date Period

Source: https://documentation.flowable.com/latest/reactmodel/forms/concept/form-expressions

Returns the start of a specified date period (e.g., 'month', 'year') for a given date. For example, 'month' will return the first day of the month.

```javascript
flw.startOf(flw.now(), 'month')
```

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

### Install RPA Framework Libraries for Execution

Source: https://documentation.flowable.com/latest/develop/external-clients/rpaframework/introduction

These commands install the necessary Python libraries to execute different RPA formats. 'rpaframework' is for .action files, 'robocorp-tasks' for tasks without return values, and 'robocorp-actions' for functions returning results to Flowable.

```bash
pip install rpaframework
```

```bash
pip install robocorp-tasks
```

```bash
pip install robocorp-actions
```

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

### Complex Form Expression Example

Source: https://documentation.flowable.com/latest/reactmodel/forms/concept/form-expressions

A comprehensive example combining logical, conditional, and variable access within a single form expression.

```javascript
{{user.age + 1 == 21 && !user.admin ? "Next year you can become an admin" : user.admin ? "admin" : "go away " + user.name }}
```

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

### GET /app-repository/app-definitions

Source: https://documentation.flowable.com/latest/assets/core-swagger/app.html

Retrieves a list of all available app definitions.

```APIDOC
## GET /app-repository/app-definitions

### Description
List of app definitions.

### Method
GET

### Endpoint
/app-repository/app-definitions
```

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

### GET /event-registry-repository/deployments

Source: https://documentation.flowable.com/latest/assets/core-swagger/eventregistry.html

List all deployments or create a new one within the event registry.

```APIDOC
## GET /event-registry-repository/deployments

### Description
Retrieve a list of all event registry deployments.

### Method
GET

### Endpoint
/event-registry-repository/deployments

## POST /event-registry-repository/deployments

### Description
Create a new deployment in the event registry.

### Method
POST

### Endpoint
/event-registry-repository/deployments
```

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

### Basic Form Expression Examples

Source: https://documentation.flowable.com/latest/reactmodel/forms/concept/form-expressions

Demonstrates the use of literals (boolean, number, string) and variable access within form expressions.

```javascript
{{true}}
```

```javascript
{{5}}
```

```javascript
{{"hello"}}
```

```javascript
{{disabled}}
```

```javascript
{{$currentUser.id}}
```

```javascript
{{$currentUser.memberGroups.has('clientAdvisor')}}
```

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

### GET /history/historic-process-instances

Source: https://documentation.flowable.com/latest/assets/core-swagger/bpmn.html

Retrieve a list of historic process instances.

```APIDOC
## GET /history/historic-process-instances

### Description
List of historic process instances.

### Method
GET

### Endpoint
/history/historic-process-instances
```

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

### GET /history/historic-process-instances/{processInstanceId}

Source: https://documentation.flowable.com/latest/assets/core-swagger/bpmn.html

Retrieve details for a specific historic process instance.

```APIDOC
## GET /history/historic-process-instances/{processInstanceId}

### Description
Get a historic process instance.

### Method
GET

### Endpoint
/history/historic-process-instances/{processInstanceId}

### Parameters
#### Path Parameters
- **processInstanceId** (string) - Required - The ID of the historic process instance.
```

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

### Dynamic Pagination in Flowable Queries

Source: https://documentation.flowable.com/latest/howto/howto/howto-advanced-search

Maps URL parameters 'start' and 'pageSize' to Elasticsearch 'from' and 'size' fields, providing default values if parameters are not supplied.

```JSON
{\n  "from": "${start!0}",\n  "size": "${pageSize!20}"\n}
```

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

### Full Case Mapping Extension Configuration

Source: https://documentation.flowable.com/latest/howto/howto/howto-advanced-search

A complete example of a case mapping extension file that defines custom phonetic analysis and additional indexed properties.

```json
{
  "key": "client-case-mapping-extension",
  "extends": "case-instances",
  "version": 1,
  
  "settings": {
    "analysis": {
      "analyzer": {
        "phonetic_analyzer": {
          "type": "custom",
          "tokenizer": "standard",
          "filter": [
            "lowercase",
            "phonetic_filter"
          ]
        }
      },
      "filter": {
        "phonetic_filter": {
          "type": "phonetic",
          "encoder": "metaphone",
          "replace": false
        }
      }
    }
  },
  
  "properties": {
    "clientName_typeAhead": {
      "type": "text",
      "analyzer": "ngrams",
      "search_analyzer": "standard",
      "copy_to": [ "clientName_phonetic", "clientName_edge" ]
    },
    "clientName_phonetic": {
      "type": "text",
      "analyzer": "phonetic_analyzer"
    },
    "clientName_edge": {
      "type": "text",
      "search_analyzer": "standard",
      "analyzer": "edge_ngrams"
    },
    "address_typeAhead": {
      "type": "text",
      "analyzer": "ngrams",
      "search_analyzer": "standard",
      "copy_to": "fullTextVariables"
    }
  },
  
  "fullTextVariables": [
    {
      "name": "firstName",
      "scopeDefinitionKey": "searchSampleClientCase"
    },
    {
      "name": "lastName",
      "scopeDefinitionKey": "searchSampleClientCase"
    },
    {
      "name": "comments",
      "scopeDefinitionKey": "searchSampleClientCase"
    }
  ]
}
```

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

### GET /event-registry-repository/channel-definitions

Source: https://documentation.flowable.com/latest/assets/core-swagger/eventregistry.html

Retrieve a list of all channel definitions registered in the system.

```APIDOC
## GET /event-registry-repository/channel-definitions

### Description
List all channel definitions available in the event registry.

### Method
GET

### Endpoint
/event-registry-repository/channel-definitions
```

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

### Example Resolved Endpoints Object

Source: https://documentation.flowable.com/latest/reactmodel/forms/concept/form-expressions

The structure of the endpoints object when a baseUrl is configured.

```json
"endpoints": {  
    "baseUrl": "/flowable-work",  
    "action": "/flowable-work/action-api",  
    "engage": "/flowable-work/engage-api",  
    "form": "/flowable-work/form-api",  
    "idm": "/flowable-work/idm-api",  
    "report": "/flowable-work/platform-api/reports",  
    "cmmn": "/flowable-work/cmmn-api",  
    "process": "/flowable-work/process-api",  
    "platform": "/flowable-work/platform-api",  
    "login": "/flowable-work/auth/login",  
    "logout": "/flowable-work/auth/logout",  
    "auth": "/flowable-work/auth",  
    "content": "/flowable-work/content-api",  
    "dmn": "/flowable-work/dmn-api",  
    "dataobject": "/flowable-work/dataobject-api",  
    "audit": "/flowable-work/platform-api",  
    "actuator": "/flowable-work/actuator",  
    "template": "/flowable-work/template-api",  
    "inspect": "/flowable-work/inspect-api"  
}  
```

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

### GET /cmmn-runtime/plan-item-instances/{planItemInstanceId}/variables/{variableName}/data

Source: https://documentation.flowable.com/latest/assets/core-swagger/cmmn.html

Retrieve binary data for a specific variable in a plan item instance.

```APIDOC
## GET /cmmn-runtime/plan-item-instances/{planItemInstanceId}/variables/{variableName}/data

### Description
Get the binary data for a variable.

### Method
GET

### Endpoint
/cmmn-runtime/plan-item-instances/{planItemInstanceId}/variables/{variableName}/data

### Parameters
#### Path Parameters
- **planItemInstanceId** (string) - Required - The ID of the plan item instance
- **variableName** (string) - Required - The name of the variable
```

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

### Case Instances API

Source: https://documentation.flowable.com/latest/assets/core-swagger/cmmn.html

Endpoints for querying, starting, managing, and deleting CMMN case instances.

```APIDOC
## POST /cmmn-query/case-instances

### Description
Query case instances.

### Method
POST

### Endpoint
/cmmn-query/case-instances
```

```APIDOC
## GET /cmmn-runtime/case-instances

### Description
List case instances.

### Method
GET

### Endpoint
/cmmn-runtime/case-instances
```

```APIDOC
## POST /cmmn-runtime/case-instances

### Description
Start a case instance.

### Method
POST

### Endpoint
/cmmn-runtime/case-instances
```

```APIDOC
## POST /cmmn-runtime/case-instances/delete

### Description
Post action request to delete/terminate a bulk of case instances.

### Method
POST

### Endpoint
/cmmn-runtime/case-instances/delete
```

```APIDOC
## GET /cmmn-runtime/case-instances/{caseInstanceId}

### Description
Get a case instance.

### Method
GET

### Endpoint
/cmmn-runtime/case-instances/{caseInstanceId}
```

```APIDOC
## PUT /cmmn-runtime/case-instances/{caseInstanceId}

### Description
Update case instance properties or execute an action on a case instance (body needs to contain an 'action' property for the latter).

### Method
PUT

### Endpoint
/cmmn-runtime/case-instances/{caseInstanceId}
```

```APIDOC
## DELETE /cmmn-runtime/case-instances/{caseInstanceId}

### Description
Terminate a case instance.

### Method
DELETE

### Endpoint
/cmmn-runtime/case-instances/{caseInstanceId}
```

```APIDOC
## POST /cmmn-runtime/case-instances/{caseInstanceId}/change-state

### Description
Change the state of a case instance.

### Method
POST

### Endpoint
/cmmn-runtime/case-instances/{caseInstanceId}/change-state
```

```APIDOC
## DELETE /cmmn-runtime/case-instances/{caseInstanceId}/delete

### Description
Delete a case instance.

### Method
DELETE

### Endpoint
/cmmn-runtime/case-instances/{caseInstanceId}/delete
```

```APIDOC
## GET /cmmn-runtime/case-instances/{caseInstanceId}/diagram

### Description
Get diagram for a case instance.

### Method
GET

### Endpoint
/cmmn-runtime/case-instances/{caseInstanceId}/diagram
```

```APIDOC
## POST /cmmn-runtime/case-instances/{caseInstanceId}/migrate

### Description
Migrate case instance.

### Method
POST

### Endpoint
/cmmn-runtime/case-instances/{caseInstanceId}/migrate
```

```APIDOC
## GET /cmmn-runtime/case-instances/{caseInstanceId}/stage-overview

### Description
Get a stage overview of a case instance.

### Method
GET

### Endpoint
/cmmn-runtime/case-instances/{caseInstanceId}/stage-overview
```

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

### POST /app-repository/deployments

Source: https://documentation.flowable.com/latest/assets/core-swagger/app.html

Creates a new app deployment.

```APIDOC
## POST /app-repository/deployments

### Description
Create a new app deployment.

### Method
POST

### Endpoint
/app-repository/deployments
```

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

### Get Current Date and Time UTC

Source: https://documentation.flowable.com/latest/reactmodel/forms/concept/form-expressions

Retrieves the current date and time in UTC. This is the standard way to get the current timestamp.

```javascript
flw.now()
```

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

### Implement Freemarker Query Template

Source: https://documentation.flowable.com/latest/howto/howto/howto-advanced-search

Define the dynamic query structure using Freemarker syntax to handle optional search parameters and conditional logic.

```ftl
<#ftl output_format="JSON">
{
    "from": "${start!0}",
    "size": "${pageSize!20}",

<#if !(termOperator?has_content)>
    <#assign termOperator = 'AND'>
</#if>

    "query": {
        "bool": {
            "must": [
                {
                    "term": {
                        "caseDefinitionKey": "searchSampleClientCase"
                    }
                },
                {
                    "term": {
                        "state": "active"
                    }
                }
<#if caseId?has_content>
                ,{
                    "term": {
                        "_id": "${caseId}"
                    }
                }
<#else>
    <#if clientName?has_content>
                ,{
                    "match": {
                        "clientName_typeAhead": {
                            "query": "${clientName}",
                            "operator": "${termOperator}"
                        }
                    }
                }
    </#if>
    <#if clientNameEdge?has_content>
                ,{
                    "match": {
                        "clientName_edge": {
                            "query": "${clientNameEdge}",
                            "operator": "${termOperator}"
                        }
                    }
                }
    </#if>
    <#if clientNamePhonetic?has_content>
                ,{
                    "match": {
                        "clientName_phonetic": {
                            "query": "${clientNamePhonetic}",
                            "operator": "${termOperator}"
                        }
                    }
                }
    </#if>
    <#if address?has_content>
                ,{
                    "match": {
                        "address_typeAhead": {
                            "query": "${address}",
                            "operator": "${termOperator}"
                        }
                    }
                }
    </#if>
    <#if fullText?has_content>
                ,{
                    "match": {
                        "fullTextVariables": {
                            "query": "${fullText}",
                            "operator": "${termOperator}"
                        }
                    }
                }
    </#if>
    <#if birthday?has_content>
                ,{
                    "nested": {
                        "path": "variables",
                        "query": {
                            "bool": {
                                "must": [
                                    {
                                        "term": {
                                            "variables.name": "birthday"
                                        }
                                    },
                                    {
                                        "term": {
                                            "variables.dateValue": "${birthday}"
                                        }
                                    }
                                ]
                            }
                        }
                    }
                }
    </#if>
    <#if countryKey?has_content>
                ,{
                    "nested": {
                        "path": "variables",
                        "query": {
                            "bool": {
                                "must": [
                                    {
                                        "term": {

```

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

### GET /cmmn-management/deadletter-jobs

Source: https://documentation.flowable.com/latest/assets/core-swagger/cmmn.html

Retrieve a list of all deadletter jobs.

```APIDOC
## GET /cmmn-management/deadletter-jobs

### Description
List all deadletter jobs.

### Method
GET

### Endpoint
/cmmn-management/deadletter-jobs
```

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

### GET /form-management/engine

Source: https://documentation.flowable.com/latest/assets/core-swagger/form.html

Retrieves information about the form engine.

```APIDOC
## GET /form-management/engine

### Description
Get form engine info.

### Method
GET

### Endpoint
/form-management/engine
```

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

### GET /runtime/tasks/{taskId}

Source: https://documentation.flowable.com/latest/assets/core-swagger/bpmn.html

Retrieve details for a specific task.

```APIDOC
## GET /runtime/tasks/{taskId}

### Description
Get a task.

### Method
GET

### Endpoint
/runtime/tasks/{taskId}

### Parameters
#### Path Parameters
- **taskId** (string) - Required - The ID of the task to retrieve
```

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

### GET /management/jobs

Source: https://documentation.flowable.com/latest/assets/core-swagger/bpmn.html

List all jobs currently managed by the engine.

```APIDOC
## GET /management/jobs

### Description
List jobs.

### Method
GET

### Endpoint
/management/jobs
```

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

### Register Process and Case Event Subscriptions

Source: https://documentation.flowable.com/latest/howto/howto/howto-manual-start-event-subscriptions

Demonstrates how to use the builder API to register event subscriptions for specific process or case definitions using correlation parameters.

```java
public void registerEventSubscription(RuntimeService runtimeService) {  
    // subscribe for address change event type coming from the CRM  
    runtimeService.createProcessInstanceStartEventSubscriptionBuilder()  
        .processDefinitionKey("customerChangeProcess")  
        .addCorrelationParameterValue("eventType", "addressChange")  
        .addCorrelationParameterValue("sourceType", "CRM")  
        .subscribe();  
}
```

```java
public void registerEventSubscription(CmmnRuntimeService cmmnRuntimeService) {  
    // subscribe for address change event type coming from the CRM  
    cmmnRuntimeService.createCaseInstanceStartEventSubscriptionBuilder()  
        .caseDefinitionKey("customerChangeCase")  
        .addCorrelationParameterValue("eventType", "budgetChange")  
        .addCorrelationParameterValue("sourceType", "ERP")  
        .subscribe();  
}
```

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

### GET /runtime/tasks/{taskId}/variables

Source: https://documentation.flowable.com/latest/assets/core-swagger/bpmn.html

List variables associated with a task.

```APIDOC
## GET /runtime/tasks/{taskId}/variables

### Description
List variables for a task.

### Method
GET

### Endpoint
/runtime/tasks/{taskId}/variables

### Parameters
#### Path Parameters
- **taskId** (string) - Required - The ID of the task
```

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

### Define Query Metadata

Source: https://documentation.flowable.com/latest/howto/howto/howto-advanced-search

Create a JSON file in the custom mapping extension directory to define the query key, source index, and template resource path.

```json
{
  "key": "client-search",
  "sourceIndex": "case-instances",
  "type": "query",
  "version": 1,
  "templateResource": "classpath:/com/flowable/indexing/mapping-extension/custom/client-search-dynamic-query.ftl"
}
```

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

### GET /app-management/incidents

Source: https://documentation.flowable.com/latest/assets/core-swagger/app.html

Lists all incidents within the app management engine.

```APIDOC
## GET /app-management/incidents

### Description
List incidents.

### Method
GET

### Endpoint
/app-management/incidents
```

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

### Dynamically Adding Client Name Edge to Should Clause

Source: https://documentation.flowable.com/latest/howto/howto/howto-advanced-search

This example shows how to dynamically add an 'edge' match for client name to the 'should' clause, handling cases where previous 'should' clauses may or may not exist. It applies a higher boost for more precise matching.

```freemarker
<#if clientNameEdge?has_content>
    <#if hasShouldClause>
        ,
    <#else>
        <#assign hasShouldClause = true>
        ],
        "should": [
    </#if>
            {
                "match": {
                    "clientName_edge": {
                        "query": "${clientNameEdge}",
                        "operator": "${termOperator}",
                        "boost": 5
                    }
                }
            }
</#if>

```

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

### POST /event-registry-runtime/event-instances

Source: https://documentation.flowable.com/latest/assets/core-swagger/eventregistry.html

Send an event instance to the event registry runtime.

```APIDOC
## POST /event-registry-runtime/event-instances

### Description
Send a new event instance to be processed by the engine.

### Method
POST

### Endpoint
/event-registry-runtime/event-instances

### Request Body
- **EventInstanceCreateRequest** (object) - Required - The event instance data to be sent.
```

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

### GET /cmmn-repository/case-definitions

Source: https://documentation.flowable.com/latest/assets/core-swagger/cmmn.html

Retrieves a list of all case definitions available in the repository.

```APIDOC
## GET /cmmn-repository/case-definitions

### Description
List of case definitions.

### Method
GET

### Endpoint
/cmmn-repository/case-definitions
```

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

### System API

Source: https://documentation.flowable.com/latest/assets/core-swagger/core.html

Endpoints for retrieving system information.

```APIDOC
## GET /system/info

### Description
Display System information for all nodes.

### Method
GET

### Endpoint
/system/info

### Response
#### Success Response (200)
- **NodeInformation** (object) - Description of system information for all nodes.
```

```APIDOC
## GET /system/info/current

### Description
Display System information for the current node.

### Method
GET

### Endpoint
/system/info/current

### Response
#### Success Response (200)
- **NodeInformation** (object) - Description of system information for the current node.
```

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

### POST /runtime/event-subscriptions/migrate

Source: https://documentation.flowable.com/latest/howto/howto/howto-manual-start-event-subscriptions

Migrates manually created event subscriptions for a specific process definition to a new version.

```APIDOC
## POST /runtime/event-subscriptions/migrate

### Description
Migrates manually created event subscriptions from an old process definition to a target version. This can be done to the latest version or a specific process definition ID.

### Method
POST

### Endpoint
/runtime/event-subscriptions/migrate

### Parameters
#### Request Body
- **oldProcessDefinitionId** (String) - Required - The ID of the current process definition.
- **newProcessDefinitionId** (String) - Optional - The target process definition ID to migrate to.
- **correlationParameters** (Map) - Optional - Specific correlation values to filter subscriptions for migration.

### Request Example
{
  "oldProcessDefinitionId": "proc-123",
  "newProcessDefinitionId": "proc-456",
  "correlationParameters": {
    "eventType": "addressChange",
    "sourceType": "CRM"
  }
}

### Response
#### Success Response (200)
- **status** (String) - Migration successful

#### Response Example
{
  "status": "success"
}
```

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

### GET /cmmn-repository/case-definitions/{caseDefinitionId}

Source: https://documentation.flowable.com/latest/assets/core-swagger/cmmn.html

Retrieves details for a specific case definition by its ID.

```APIDOC
## GET /cmmn-repository/case-definitions/{caseDefinitionId}

### Description
Get a case definition.

### Method
GET

### Endpoint
/cmmn-repository/case-definitions/{caseDefinitionId}

### Parameters
#### Path Parameters
- **caseDefinitionId** (string) - Required - The unique identifier of the case definition.
```

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

### Default Endpoints

Source: https://documentation.flowable.com/latest/assets/core-swagger/core.html

Miscellaneous endpoints including starting forms and license information.

```APIDOC
## GET /case-definitions/{caseDefinitionId}/start-form

### Description
Get the start form for a case definition.

### Method
GET

### Endpoint
/case-definitions/{caseDefinitionId}/start-form

### Parameters
#### Path Parameters
- **caseDefinitionId** (string) - Required - The ID of the case definition.
```

```APIDOC
## GET /license

### Description
Get license information.

### Method
GET

### Endpoint
/license

### Response
#### Success Response (200)
- **LicenseInfoResponse** (object) - Information about the license.
```

```APIDOC
## GET /license/user-logins

### Description
Get information about user logins related to licenses.

### Method
GET

### Endpoint
/license/user-logins

### Response
#### Success Response (200)
- **UserLoginInfoResponse** (object) - Information about user logins.
```

```APIDOC
## GET /process-definitions/{processDefinitionId}/start-form

### Description
Get the start form for a process definition.

### Method
GET

### Endpoint
/process-definitions/{processDefinitionId}/start-form

### Parameters
#### Path Parameters
- **processDefinitionId** (string) - Required - The ID of the process definition.
```

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

### GET /cmmn-runtime/tasks/{taskId}/identitylinks

Source: https://documentation.flowable.com/latest/assets/core-swagger/cmmn.html

List all identity links associated with a specific task.

```APIDOC
## GET /cmmn-runtime/tasks/{taskId}/identitylinks

### Description
List identity links for a task.

### Method
GET

### Endpoint
/cmmn-runtime/tasks/{taskId}/identitylinks

### Parameters
#### Path Parameters
- **taskId** (string) - Required - The ID of the task
```

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

### Configure Subscription Migration Behavior

Source: https://documentation.flowable.com/latest/howto/howto/howto-manual-start-event-subscriptions

Shows how to prevent a manual event subscription from automatically migrating to the latest version of a process definition upon redeployment.

```java
public void registerEventSubscription(RuntimeService runtimeService) {  
    // subscribe for address change event type coming from the CRM  
    runtimeService.createProcessInstanceStartEventSubscriptionBuilder()  
        .processDefinitionKey("customerChangeProcess")  
        .addCorrelationParameterValue("eventType", "addressChange")  
        .addCorrelationParameterValue("sourceType", "CRM")  
        .doNotUpdateToLatestVersionAutomatically()  
        .subscribe();  
}
```

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

### GET /cmmn-runtime/case-instances/{caseInstanceId}/variables

Source: https://documentation.flowable.com/latest/assets/core-swagger/cmmn.html

Lists all variables associated with a specific case instance.

```APIDOC
## GET /cmmn-runtime/case-instances/{caseInstanceId}/variables

### Description
List variables for a case instance.

### Method
GET

### Endpoint
/cmmn-runtime/case-instances/{caseInstanceId}/variables

### Parameters
#### Path Parameters
- **caseInstanceId** (string) - Required - The unique identifier of the case instance.
```

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

### Enable Flowable 5 Compatibility Engine

Source: https://documentation.flowable.com/latest/howto/howto/howto-migration

Configures the Flowable process engine to support legacy process instances from engines like Activiti 5 or Camunda 7. This requires adding the flowable5-compatibility dependency and setting the compatibility handler on the configuration object.

```java
processEngineConfiguration.setFlowable5CompatibilityEnabled(true);
processEngineConfiguration.setFlowable5CompatibilityHandler(new DefaultFlowable5CompatibilityHandler());
```

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

### Migrate All Event Subscriptions to Latest Version (Java)

Source: https://documentation.flowable.com/latest/howto/howto/howto-manual-start-event-subscriptions

Migrates all manually created event subscriptions for a specific process definition to the latest available version. This method uses the RuntimeService to initiate the migration process.

```Java
public void migrateEventSubscriptions(RuntimeService runtimeService, String oldProcessDefinitionId) {
    // migrate all manually created event subscriptons for a particular process model,
    // regardless of their correlation parameter values
    runtimeService.createProcessInstanceStartEventSubscriptionModificationBuilder()
        .processDefinitionId(oldProcessDefinitionId)
        .migrateToLatestProcessDefinition();
}
```

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

### Process Instances API

Source: https://documentation.flowable.com/latest/assets/core-swagger/core.html

Endpoints for managing timers related to process instances.

```APIDOC
## POST /process-instances/{processInstanceId}/timers/{elementId}/stop-repetition

### Description
Stop the timer repetition for a specific timer associated with a process instance.

### Method
POST

### Endpoint
/process-instances/{processInstanceId}/timers/{elementId}/stop-repetition

### Parameters
#### Path Parameters
- **processInstanceId** (string) - Required - The ID of the process instance.
- **elementId** (string) - Required - The ID of the timer element.
```

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

### Define Data Structure

Source: https://documentation.flowable.com/latest/reactmodel/forms/concept/form-expressions

The base data structure used for the following expression function examples.

```json
{
  order: [  
    { name: "Macbook Pro",            amount: 11,  price: 2631.32, category: "laptop" },  
    { name: "Samsung 27''",           amount: 4,   price: 304.12,  category: "peripheral" },  
    { name: "Pack keyboard + mouse",  amount: 11,  price: 124.01,  category: "peripheral" }  
  ],  
  extraLines: [  
    { name: "Handling",               amount: 1,   price: 100.0,   category: "extra" },  
    { name: "Shipping",               amount: 1,   price: 120.0,   category: "extra" }  
  ]  
}
```

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

### Migrate All Event Subscriptions to Specific Version (Java)

Source: https://documentation.flowable.com/latest/howto/howto/howto-manual-start-event-subscriptions

Migrates all manually created event subscriptions for a specific process definition to a designated new process definition version. This allows for precise version control during migration.

```Java
public void migrateEventSubscriptions(RuntimeService runtimeService,
    String oldProcessDefinitionId, String newProcessDefinitionId) {
    // migrate all manually created event subscriptons for a particular process model,
    // regardless of their correlation parameter values
    runtimeService.createProcessInstanceStartEventSubscriptionModificationBuilder()
        .processDefinitionId(oldProcessDefinitionId)
        .migrateToProcessDefinition(newProcessDefinitionId);
}
```

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

### Datatable Query URL Expression

Source: https://documentation.flowable.com/latest/reactmodel/forms/concept/form-expressions

Example of using an endpoint variable within a datatable query URL.

```text
{{endpoints.platform}}/search/work-instances?size={{$pageSize}}&start={{$start}}&{{$sort}}&{{$filter}}  
```

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

### Form Expressions with Ecmascript Methods

Source: https://documentation.flowable.com/latest/reactmodel/forms/concept/form-expressions

Illustrates using Ecmascript methods and object attributes within form expressions.

```javascript
{{case.dueDate.toLocaleDateString()}}
```

```javascript
{{tweet.length}}
```

```javascript
{{names.join(", ")}}
```

```javascript
{{colors.indexOf['red']}}
```