OL Connect

https://help.uplandsoftware.com/objectiflune/en/olconnect/2025.1/
Admin
OL Connect is a comprehensive platform for building custom workflows, automating processes,...
Tokens:888,995
Snippets:5,931
Trust Score:10
Update:6 hours ago
Show doc for...
Tokens:
Raw
### Simple Connect installation example (installProperties.ini)

Source: https://help.uplandsoftware.com/objectiflune/en/olconnect/2025.1/Installation/Silent_Installer.html

Complete installProperties.ini file for a simple OL Connect installation. Includes logging, installation settings (product components, server credentials, database settings, shortcuts, path), and optional uninstall settings.

```ini
; OL Connect silent installer properties

; Logging properties
[Logging]
verbose = false
path = "c:\ProgramData\Objectif Lune\Installation Logs"
; 

Installation settings
[Installation]
product.Designer = true
product.Server = true
product.PrintManager = true
product.ServerExtension = false
product.MariaDB = true
product.Messenger = true
RegisterService.connectServer = true
server.username = Administrator
server.password = ObjLune
server.connection.user = olc-user
server.connection.password = secret
database.rootpassword = @Admin2022
database.username = olconnect
database.password = @Admin2022
database.remoteaccess = true
desktopShortcuts = true
path = "c:\Program Files\Objectif Lune\OL Connect"

;Optional uninstallation settings
[Uninstall]
remove = true
keepdata = false
```

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

### Server Extension installation example (installProperties.ini)

Source: https://help.uplandsoftware.com/objectiflune/en/olconnect/2025.1/Installation/Silent_Installer.html

Complete installProperties.ini file for a Server Extension installation (Enterprise edition only). Includes logging, installation settings (product components, server credentials, database connection, desktop shortcuts, server connection, path), and optional uninstall settings.

```ini
; OL Connect silent installer properties for Server Extension installation

; Logging properties
[Logging]verbose = false
path = "c:\ProgramData\Objectif Lune\Installation Logs"

; Installation settings
[Installation]
product.Designer = false
product.Server = false
product.PrintManager = false
product.ServerExtension = true
product.MariaDB = false
product.Messenger = true
RegisterService.connectServer = true
server.username = Server EX2
server.password = objlune
database.system = MariaDB
database.host = 192.168.108.50
database.username = root
database.password = Admin@123
database.schema = olconnect
database.encryptedconnection = false
database.rootpassword = Admin@123
database.remoteaccess = true
desktopShortcuts = true
server.connection.configure = true
server.connection.host = 192.168.108.50
server.connection.port = 9340
server.connection.user = ol-admin
server.connection.password = secret
path = "c:\Program Files\Objectif Lune\OL Connect"

; Optional uninstallation settings
[Uninstall]
remove = true
keepdata = false
```

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

### OL Connect silent installer INI example

Source: https://help.uplandsoftware.com/objectiflune/en/olconnect/2025.1/Installation/Silent_Installer.html

Example INI file for the OL Connect silent installer. It sets product components, server credentials, database credentials, desktop shortcuts, installation path, language, and locale. Note that database properties are ignored if database.configure is false.

```ini
; Installation settings
[Installation]
product.Designer = true
product.Server = true
product.PrintManager = true
product.ServerExtension = false
product.MariaDB = true
product.Messenger = true
RegisterService.connectServer = true
server.username = Administrator
server.password = ObjLune
server.connection.user = olc-user
server.connection.password = secret
database.rootpassword = @Admin2022
database.username = olconnect
database.password = @Admin2022
database.remoteaccess = true
desktopShortcuts = true
path = "c:\Program Files\Objectif Lune\OL Connect"
Language = fr
Locale = FR
```

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

### Logging properties example in installProperties.ini

Source: https://help.uplandsoftware.com/objectiflune/en/olconnect/2025.1/Installation/Silent_Installer.html

Example of the [Logging] section in installProperties.ini, setting verbose to false and specifying a log path. The log file name is automatically generated as Installer-YYYY-MM-DD-####.#.#.log, or Maintenance-... for maintenance installations.

```ini
; Logging properties
[Logging]
verbose = false
path = "c:\temp\Silent Install"
```

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

### Uninstall/Repair properties example

Source: https://help.uplandsoftware.com/objectiflune/en/olconnect/2025.1/Installation/Silent_Installer.html

Example INI snippet showing the [Uninstall] section with 'remove' and 'keepdata' keys. 'remove' controls whether the installer performs a Remove MSI action (true) or a Modify MSI action (false) if the product is already installed. 'keepdata' specifies whether to keep user data under %PROGRAMDATA%\Objectif Lune\OL Connect during uninstall.

```ini
; Uninstallation/Repair properties
[Uninstall]
remove = true
keepdata = true
```

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

### Control Script Example Using Channel

Source: https://help.uplandsoftware.com/objectiflune/en/olconnect/2025.1/designer/API/Channel_Enumeration.html

Example Control Script that selects different sections for Print output and for Email with the Print context attached.

```APIDOC
## Control Script Example

### Description
Demonstrates how to use the `Channel` enumeration in a Control Script to enable or disable sections based on the output channel.

### Code
```javascript
var printSections = merge.template.contexts.PRINT.sections;

if(merge.channel === Channel.EMAIL){
    printSections['Section 1'].enabled = false;
    printSections['Section 2'].enabled = true;
}

if(merge.channel === Channel.PRINT){
    printSections['Section 1'].enabled = true;
    printSections['Section 2'].enabled = false;
}
```
```

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

### get(index) example: Copy page numbers to table of contents

Source: https://help.uplandsoftware.com/objectiflune/en/olconnect/2025.1/designer/API/get.html

This script uses query to select all h1 and h2 headings, then for each heading it gets the page number and sets the text of the corresponding element in the $numbers set using get(index). The index starts at zero. This is part of a larger table of contents script.

```javascript
var $numbers = query('.number');
merge.context.query("h1, h2").each(function( index ) {    
    var pageNo = this.info().pageNo;    
    var entry = $numbers.get( index );    
    if( entry ) {        
        entry.text( pageNo );    
    }
});
```

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

### Run installer with trace logging

Source: https://help.uplandsoftware.com/objectiflune/en/olconnect/2025.1/Installation/installation-help.html

Use this command to run the OL Connect installer with full trace style logging. The log file produced will be very large as this option logs everything.

```bash
OL_Connect_<<Edition>>_2025.1.n.nnnnn_bnnnn.exe --**trace**
```

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

### Run installer with verbose logging

Source: https://help.uplandsoftware.com/objectiflune/en/olconnect/2025.1/Installation/installation-help.html

Use this command to run the OL Connect installer with extra debugging style logging. Replace <<Edition>> with Enterprise, Professional, or Desktop, and update the build number appropriately.

```bash
OL_Connect_<<Edition>>_2025.1.n.nnnnn_bnnnn.exe --**verbose**
```

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

### Example: Using steps.currentPage and steps.moveTo()

Source: https://help.uplandsoftware.com/objectiflune/en/olconnect/2025.1/datamapper/API/Object_steps.html

This example shows how to use `steps.currentPage`, `steps.moveTo()`, and `steps.currentPosition` in a DataMapper script. It moves the pointer 14 lines below the current position when the page changes, extracts data until the string "LOAD FACTOR" is encountered, and adds lines to an array.

```javascript
if(steps.currentPage > curPage) {    
    steps.moveTo(0, steps.currentPosition+14); 
    /* Moves the current position to 14 lines below the current position of the pointer in the data */    
    curPage++;
} else if(curLine.startsWith("LOAD FACTOR")) { 
/* Extracts data to the curLine variable until the string "LOAD FACTOR" is encountered */    
    break;
} else {    
    lineArray.push(curLine); 
    /* Adds the current line value (extraction) to the array */
}
```

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

### get(index)

Source: https://help.uplandsoftware.com/objectiflune/en/olconnect/2025.1/designer/API/get.html

Returns the element found at the supplied index in a set of HTML elements. The index starts counting at zero.

```APIDOC
## get(index)

### Description
Returns the element found at the supplied index in a set of HTML elements.

### Parameters
- **index** (number) - Required - Place of the element in the result set. The index starts counting at zero.

### Example
```
var $numbers = query('.number');
merge.context.query("h1, h2").each(function( index ) {    
    var pageNo = this.info().pageNo;    
    var entry = $numbers.get( index );    
    if( entry ) {        
        entry.text( pageNo );    
    }
});
```

This code is used in a script that inserts a table of contents. For the full script and explanation see [Creating a Table Of Contents](https://help.uplandsoftware.com/objectiflune/en/olconnect/2025.1/designer/Scripting/Scripting_Creating_A_TOC.html).
```

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

### cotgPhotoWidget(options)

Source: https://help.uplandsoftware.com/objectiflune/en/olconnect/2025.1/designer/COTG/COTG_API.html

Initializes a new Camera element with the specified settings. Options are provided as an array (object) of desired settings, with defaults used for unspecified options.

```APIDOC
## cotgPhotoWidget(options)

### Description
Initializes a new Camera element with the specified settings. Options are provided as an array (object) of desired settings, with defaults used for unspecified options.

### Method
Initialize

### Parameters
#### Options (Object) - Optional
An array containing the desired settings, e.g. {quality: 50, height: 1024, width: 1024}. For any unspecified options the default settings will be used.

| Option | Description | Type | Default |
| --- | --- | --- | --- |
| editimage | Allows the user to edit the image after taking or selecting it. Which editing options the user actually gets and how they are presented depends on the operating system of the device. | Boolean | false |
| encodingtype | The returned image's file encoding: `jpg` or `png`. | String | 'jpg' |
| height | The maximum height in pixels | Number | 864 |
| width | The maximum width in pixels. | Number | 1152 |
| source | Which buttons are enabled: Take now (`take`), Library (`pick`), or both (`takeandpick`). | String | 'takeandpick' |
| scaleimage | Scales the image to fit the maximum width or height. The aspect ration is maintained. | Boolean | true |
| quality | Quality of the saved image, expressed as a range of 0-100, where 100 is full resolution with no loss from file compression. | Number | 80 |
| allowannotations | Adds an Image & Annotation widget to edit the picture. | Boolean | false |
| allowdeskew | Allows the user to perform a perspective cropping after taking or selecting a picture. | Boolean | false |
| addtimestamp | Adds a time stamp | Boolean | false |
| stampFormat | The date format. For all possible formats see [Cordova documentation](https://github.com/nu-book/cordova-doc/blob/master/plugins/camera/index.md). 'L' stands for localized date and time. | String | 'L' |
| stampAlign | The position of the stamp, specified by combining horizontal alignment (left, center, right) with vertical alignment (top, middle, bottom) and joining them with a vertical bar ('|'). | String | 'bottom|left' |
| stampFontSize | The time stamp's font size: `small`, `medium`, or `large`. | String | 'medium' |

### Example
```javascript
$('#myCamera').cotgPhotoWidget({quality: 50, height: 1024});
```

### Events
#### Listens to
- **clear.cotg** - Removes the picture.
- **save-state.cotg** - Saves the path of the current picture to the local storage of the COTG app.
- **restore-state.cotg** - Restores the state of the widget when the form is reopened in the COTG app, after the app has restored previously entered values of static input fields.

#### Broadcasts
- **clear.cotg** - Fired after the user has clicked the Clear button.
- **set.cotg** - Fired after the user has taken or selected a picture.
```

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

### get() Example: Retrieve Email_Address Field

Source: https://help.uplandsoftware.com/objectiflune/en/olconnect/2025.1/datamapper/API/Method_boundaries_get.html

Retrieves all text from the Email_Address field in a CSV or database file. The region object is created with region.createRegion() and passed to boundaries.get().

```javascript
boundaries.get(region.createRegion("Email_Address"));
```

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

### Section selector example: [section^='Letter'] h1

Source: https://help.uplandsoftware.com/objectiflune/en/olconnect/2025.1/designer/Scripting/Connect_Selectors.html

CSS rule that applies formatting to h1 elements in sections whose name starts with 'Letter'. The section attribute is written by the Designer on the html element.

```css
[section^='Letter'] h1 { color: brown; }
```
Tokens:
Raw