Omnis Developer Resources

https://www.omnis.net/developers/resources/
Admin
A comprehensive hub providing documentation, downloads, community forums, and various resources for...
Tokens:768,987
Snippets:6,062
Trust Score:9.6
Update:10 months ago
Show doc for...
Tokens:
Raw
### Omnis .NET Object Integration Setup and Usage

Source: https://www.omnis.net/developers/resources/onlinedocs/SyncServer/UserGuide

This guide explains how to integrate .NET objects with Omnis Studio. It covers software requirements (Omnis Studio, .NET Framework), setup procedures like component registration and deployment, and using the .NET Example Library. The documentation details defining, constructing, and subclassing .NET objects, along with passing parameters (simple and complex types) and returning values from .NET methods. It also touches on obtaining enumeration values, adding .NET classes, and error handling.

```Omnis
// Example: Assuming a .NET class 'MyNamespace.MyDotNetClass' exists

// Register the .NET component (typically done outside the script)
// ...

// Define and construct a .NET object
local loDotNetObject as DotNetObject
create object loDotNetObject from "MyNamespace.MyDotNetClass"

// Call a .NET method with simple parameters
local lvMessage as character
set lvMessage = loDotNetObject.GetMessage("World")

// Call a .NET method with complex parameters (e.g., a string array)
local laArgs as string[]
set laArgs =("arg1", "arg2")
loDotNetObject.ProcessArray(laArgs)

// Obtain an Enum value
local loStatusEnum as DotNetObject
set loStatusEnum = loDotNetObject.GetStatusEnum()
local liStatusCode as integer
set liStatusCode = loStatusEnum.Value

// Error handling
try
  // ... call .NET methods ...
catch
  // Handle .NET exceptions
  Do ^error.ShowError($error)
end try

release loDotNetObject
```

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

### Omnis Synchronisation Server User Guide - Introduction

Source: https://www.omnis.net/developers/resources/onlinedocs/Programming/00about

Overview of the Omnis Synchronisation Server, including its purpose and initial setup steps.

```APIDOC
## Omnis Synchronisation Server User Guide - Introduction

### Description
This section provides an introduction to the Omnis Synchronisation Server, covering its core functionalities and concepts.

### Method
N/A (Documentation section)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Install Event Handler with JavaScript

Source: https://www.omnis.net/developers/resources/onlinedocs/WebDev/02jsremoteforms

Provides examples of using the JavaScript: command within the $init method to install event handlers for controls. It demonstrates attaching an 'onselect' handler and a 'keydown' event listener, both calling Omnis methods via `__form.callMethodEx`.

```OmnisScript
JavaScript: document.getElementById("jsTEMP1_1076_client").onselect=function(event) { __form.callMethodEx("selected",0,event); };
```

```OmnisScript
JavaScript: window.addEventListener("keydown",function(event){ __form.callMethodEx("keydown",0,event) }, true);
```

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

### Omnis App Framework User Guide - Setup Android

Source: https://www.omnis.net/developers/resources/onlinedocs/Programming/00about

Instructions for setting up the Omnis App Framework on Android devices, including support library information.

```APIDOC
## Omnis App Framework User Guide - Setup Android

### Description
This section details the necessary steps and configurations for setting up the Omnis App Framework on Android platforms, including information on required support libraries.

### Method
N/A (Documentation section)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Omnis Script: Startup Task Construct Method

Source: https://www.omnis.net/developers/resources/support/newsletter/jun_05

Example of a $construct() method for a startup task subclass in Omnis Script. It includes calling the inherited constructor, installing a menu, and setting up an 'About' method. The method is designed to be extended with additional custom code.

```Omnis Script
Do inherited
Install menu mainMenu
Set 'About...' method aboutCode/About Task Demo
; other code as needed
```

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

### Omnis Synchronisation Server User Guide - Using the Web Interface

Source: https://www.omnis.net/developers/resources/onlinedocs/Programming/00about

Guide to utilizing the web-based interface for managing the Omnis Synchronisation Server.

```APIDOC
## Omnis Synchronisation Server User Guide - Using the Web Interface

### Description
An explanation of the features and functionalities available through the web interface for monitoring and managing synchronization tasks.

### Method
N/A (Documentation section)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Omnis Script: Startup Task Setup Method for Object References

Source: https://www.omnis.net/developers/resources/support/newsletter/jun_05

Demonstrates the $setup() method in Omnis Script for creating object references. It uses the $clib.$objects.commonMethods.$newref() function to establish a reference, allowing for subsequent object instance management.

```Omnis Script
Calculate fn as $clib.$objects.commonMethods.$newref()
; other code as needed
```

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

### Python Worker Object

Source: https://www.omnis.net/developers/resources/onlinedocs/WebDev/01tutorial

Guide to integrating Python scripts within Omnis using the Python Worker Object, including installation, setup, and error handling.

```APIDOC
## Python Worker Object

### Description
This documentation details the Python Worker Object, enabling Omnis applications to execute Python scripts and integrate Python functionality. It covers the installation process, setting up a Python worker environment, calling Python methods, and managing potential errors during execution.

### Key Features
*   Installation
*   Setting up a Python worker
*   Calling Python methods
*   Error handling
```

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

### Omnis App Framework User Guide

Source: https://www.omnis.net/developers/resources/onlinedocs/index_detail=WebDev%2F00about.html

Guide for using the Omnis App Framework, including setup for Android.

```APIDOC
## Omnis App Framework User Guide

### Sections

- **Omnis App Framework**: General information about the framework.
- **User Guide**: Comprehensive user guide.
  - **Setup – Android**: Instructions for setting up the framework on Android devices.
    - Support Library: Information on the required support library.
```

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

### Omnis App Framework User Guide

Source: https://www.omnis.net/developers/resources/onlinedocs/AppFramework/00usage

User guide for the Omnis App Framework, focusing on setup and configuration, particularly for Android platforms.

```APIDOC
## Omnis App Framework User Guide

### Description
This guide details the setup and usage of the Omnis App Framework, with specific instructions for Android platform configuration.

### Sections
- **Omnis App Framework**: General information about the framework.
- **User Guide**: Comprehensive user documentation.
  - **Setup – Android**: Specific instructions for setting up the framework on Android devices, including details on the Support Library.
```

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

### JavaScript Component Examples

Source: https://www.omnis.net/developers/resources/onlinedocs/WebDev/00about

Access example applications and code snippets for JavaScript components, serving as a starting point for development.

```JavaScript
// Example Apps and Code
```

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

### Omnis App Framework User Guide

Source: https://www.omnis.net/developers/resources/onlinedocs/ExtendingOmnis/00about

User guide for the Omnis App Framework, focusing on setup and development.

```APIDOC
## Omnis App Framework User Guide

### Description
This guide covers the Omnis App Framework, including its core concepts and setup procedures, with a specific focus on Android development.

### Sections

- **Omnis App Framework**: General introduction to the framework.
- **User Guide**: Detailed usage instructions.
  - **Setup – Android**: Specific setup instructions for Android development.
    - **Support Library**: Information regarding the necessary support libraries for Android.
```

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

### Omnis Script: Launching Task Instances (Method Command and Notational)

Source: https://www.omnis.net/developers/resources/support/newsletter/jun_05

Illustrates two techniques in Omnis Script for launching task instances: the method command 'Open task instance' and the notational method $open(). Both are used to start 'memberTask' and 'reportTask' from the startup task.

```Omnis Script
Open task instance memberTask (fn)
Do $clib.$tasks.reportTask.$open(,fn)
```

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

### Initialize Tree List with Root Nodes

Source: https://www.omnis.net/developers/resources/support/newsletter/aug_07

This snippet demonstrates the initial setup for a Tree List using the kFlatList technique. It involves retrieving root nodes and formatting them for display, often by assigning unique identifiers and setting expand/collapse properties to ensure the disclosure icon is visible even if no children are initially present. This prepares the tree for dynamic content loading.

```Omnis Script
Do treeref.$setnodelist(kFlatList, 0, transferList)
```

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

### Omnis App Framework User Guide

Source: https://www.omnis.net/developers/resources/onlinedocs/index_detail=AppFramework%2F00usage.html

Guide for using the Omnis App Framework, including setup instructions for Android.

```APIDOC
## Omnis App Framework User Guide

### Overview
Introduction to the Omnis App Framework.

### Setup – Android
Instructions for setting up the Omnis App Framework on Android devices.

#### Support Library
Information regarding the necessary support libraries for Android integration.
```

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

### Omnis Java Object Integration Setup and Usage

Source: https://www.omnis.net/developers/resources/onlinedocs/SyncServer/UserGuide

This documentation covers the setup and usage of Java objects within Omnis Studio. It details software requirements, environment variable configuration, memory allocation, and the Java Class Cache. The process of defining, constructing, and subclassing Java objects is explained, along with how to pass parameters (simple and complex types) and return values from Java methods. It also addresses data type mapping, performance considerations, error handling, and adding Java classes at runtime.

```Omnis
// Example: Assuming a Java class 'com.example.MyJavaClass' exists

// Define and construct a Java object
local loJavaObject as JavaObject
create object loJavaObject from "com.example.MyJavaClass"

// Call a Java method with simple parameters
local lvResult as character
set lvResult = loJavaObject.myMethod("hello", 123)

// Call a Java method with complex parameters (e.g., a list)
local llData as list
// ... populate llData ...
loJavaObject.processList(llData)

// Get a value from a Java object property
local liCount as integer
set liCount = loJavaObject.getCount()

// Error handling
try
  // ... call Java methods ...
catch
  // Handle Java exceptions
  Do ^error.ShowError($error)
end try

release loJavaObject
```

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

### Omnis ODBC Driver

Source: https://www.omnis.net/developers/resources/onlinedocs/WebDev/02jsremoteforms

Guide to enabling ODBC access, downloading, installing, configuring, and testing the Omnis ODBC Driver.

```APIDOC
## Omnis ODBC Driver

### Enable ODBC Access

- Select Tables
- Select Users

### Download and Install the Driver

### Configure ODBC DSNs

### Testing the DSN

- Using Omnis Studio
- Using Excel
- Other Apps

### Using SQL
```

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

### JavaScript Component Examples

Source: https://www.omnis.net/developers/resources/onlinedocs/index_detail=AppFramework%2F00usage.html

This section provides example applications and code snippets for JavaScript components. It serves as a starting point for understanding and implementing custom JavaScript components within the Omnis Net framework.

```JavaScript
// Example JavaScript component code would go here.
// This might include definitions for custom components,
// event handlers, or utility functions.
```

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

### Initialize Omnis Synchronization ($syncinit)

Source: https://www.omnis.net/developers/resources/onlinedocs/SyncServer/UserGuide

Initializes synchronization with a SyncServer using provided authentication and host details. It accepts parameters like username, password, host string, and an optional timeout. Custom parameters can also be passed for advanced configurations. Upon completion, $sqldone() is invoked.

```Omnis Script
Do config.$define(Username, Password, HostString, Timeout, MyParam) ;;define using local variables
Do config.$assigncols(‘user1’,’xxxxxx’,’http://192.168.0.10:7001’, 5, 1234)
Do oSQL.$syncinit(config) Returns id
```

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

### Install Menu Command Syntax with Parameters

Source: https://www.omnis.net/developers/resources/support/newsletter/jun11_03

Demonstrates the syntax for the 'Install menu' command, allowing for the specification of menu class, optional instance name, and construction parameters. Parameters are passed as a comma-delimited set enclosed in parentheses.

```Omnis Script
Install menu <menuclass>/[<instancename>] (<parameters>)
```

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

### Omnis App Framework User Guide API

Source: https://www.omnis.net/developers/resources/onlinedocs/FunctionRef/index

API endpoints for the Omnis App Framework, including setup instructions for Android.

```APIDOC
## Omnis App Framework User Guide API

### Description
This API relates to the Omnis App Framework, providing access to user guide information, particularly focusing on setup procedures for different platforms. The current documentation includes details on setting up the framework for Android, including support library information.

### Method
GET

### Endpoint
/appFramework/userGuide

### Parameters
#### Path Parameters
None

#### Query Parameters
- **platform** (string) - Optional - Specifies the platform for which setup information is requested (e.g., `android`).

#### Request Body
None

### Request Example (Get Android Setup)
```json
{
  "request": "getSetupInfo",
  "platform": "android"
}
```

### Response
#### Success Response (200)
- Returns setup instructions and relevant details for the specified platform.

#### Response Example (Android Setup)
```json
{
  "platform": "android",
  "setupInstructions": [
    "Include the Omnis App Framework support library in your project.",
    "Configure necessary permissions in the AndroidManifest.xml."
  ],
  "supportLibrary": "com.omnis.appframework:framework-core:1.0.0"
}
```
```

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

### Using the Web Interface

Source: https://www.omnis.net/developers/resources/onlinedocs/SyncServer/UserGuide

Explains how to access and enable the remote administration web interface for SyncServer. It provides the URL format, steps to enable the feature, and notes on file management.

```APIDOC
## Using the Web Interface

### Description
SyncServer offers remote administration capabilities through a web interface, accessible via a web browser or JSWrapper application.

### Accessing the Web Interface
- **URL Format**: `http://<SyncServer_IP>:<Server_Port>/jschtml/rfSyncServer.htm`
- **Example**: `http://127.0.0.1:7001/jschtml/rfSyncServer.htm`
- The `rfSyncServer.htm` form mirrors the desktop interface.

### Enabling the Web Interface
1. Use the desktop interface.
2. Navigate to the 'CDB Config' pane.
3. Check the 'Enable Web Interface' checkbox (available from SyncServer version 2.3.2).
4. Press 'Save Changes'.
   - This action generates `rfSyncServer.htm` in the Omnis `html` folder.

### Web Interface File Management
- **Moving the Form**: The generated `rfSyncServer.htm` can be moved to your webserver's public HTML folder for internet access.
- **Disabling the Web Interface**: Unchecking 'Enable Web Interface' and saving changes deletes `rfSyncServer.htm` from the Omnis `html` folder. **Note**: This does not remove copies placed in other webserver folders.
```

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

### SyncServer: Initialize Sync with Custom Parameters (OmnisScript)

Source: https://www.omnis.net/developers/resources/onlinedocs/SyncServer/UserGuide

Demonstrates how to initialize the SyncServer synchronization process using OmnisScript, passing custom parameters that can be referenced within SyncServer filters. This allows for device-specific or user-specific synchronization logic.

```omnisscript
Do config.$define(Username, Password, HostString, Timeout, MyID)
Do config.$assigncols(‘user1’,’xxxxxx’,’http://192.168.0.10:7001/ultra?OmnisClass=rtSync&OmnisLibrary=SyncServer’, 5, 1234)
Do oSQL.$syncinit(config) Returns id
```

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

### Check Box Control Example in Omnis Net

Source: https://www.omnis.net/developers/resources/onlinedocs/index_detail=SyncServer%2Fuserguide.html

Provides a basic example of how to implement and use the Check Box Control within an Omnis Net application. This demonstrates the fundamental setup and potential interaction with a checkbox.

```Omnis Script
; Check Box Control Example
; Placeholder for Omnis script related to a Check Box.
; Example:
; Create CheckBox myCheckbox in window
; myCheckbox.text = 'Enable Feature'
; OnChange myCheckbox
;   If myCheckbox.value = kTrue
;     ShowMessage('Feature enabled')
;   Else
;     ShowMessage('Feature disabled')
;   EndIf
; EndChange
```

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

### Omnis Synchronisation Server User Guide

Source: https://www.omnis.net/developers/resources/onlinedocs/ExtendingOmnis/00about

Documentation for the Omnis Synchronisation Server, covering setup, configuration, and usage.

```APIDOC
## Omnis Synchronisation Server User Guide

### Description
This guide provides comprehensive information on using the Omnis Synchronisation Server, including database selection, user group management, device configuration, handling primary keys, and replication.

### Sections

- **Introduction**: Overview of the Omnis Synchronisation Server.
- **Selecting the Consolidated Database**: How to choose the database for consolidated data.
- **Synchronisation User Groups**: Managing user groups for synchronization.
- **Synchronisation Devices**: Configuring synchronization devices.
- **CDB Tables**: Information on Consolidated Database tables.
- **Client Tables**: Details on client-side tables.
  - **Use of Bind Variables**: Best practices for using bind variables in client tables.
- **Sync Cache**: Understanding the synchronization cache.
- **Synchronisation Types**: Explains different synchronization methods:
  - Uplink only
  - Downlink only
  - Normal Synchronisation
  - Reload only
  - Uplink and Reload
  - None
- **Server-Side Replication**: Configuring and managing server-side data replication.
- **Handling Primary Keys**: Strategies for managing primary keys during synchronization.
  - **Primary Key Enforcement**: Ensuring primary key integrity.
- **Omnis Running as a Service**: How to run Omnis as a background service.
- **Using the Web Interface**: Navigating and utilizing the server's web interface.
- **Synchronising with the SyncServer**: Procedures for synchronizing data.
  - **Synchronisation Initialization**: Initializing the synchronization process.
  - **Synchronisation Request**: Making synchronization requests.
- **Client-side Synchronisation Tables**: Overview of tables used for client synchronization.
- **FAQs**: Frequently Asked Questions about the synchronization server.
```

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

### PostgreSQL Logon Configuration File Example

Source: https://www.omnis.net/developers/resources/technotes/tnsq0037a

A sample configuration file used for connecting to a PostgreSQL database during the conversion process. This text file contains essential logon parameters.

```text
hostname=192.168.0.10
port=5432
username=postgres
password=postgres
database=postgres
```

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

### JavaScript Worker Object

Source: https://www.omnis.net/developers/resources/onlinedocs/WebDev/02jsremoteforms

Guide to the JavaScript Worker Object, covering NPM usage, enabling JavaScript methods, module loading, and worker creation with examples.

```APIDOC
## JavaScript Worker Object

### Description
This guide details the JavaScript Worker Object, including its use with NPM, how to enable JavaScript methods, auto-loading modules, creating modules, and setting up the worker. It also covers properties, methods, and provides an example for adding ZIP support.

### Method
N/A (Documentation of available methods)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A

## NPM
[Information on using NPM with the JavaScript Worker]

## Enabling JavaScript Methods
[Steps to enable JavaScript methods]

## Auto Loading modules
[Explanation of automatic module loading]

## Creating Modules
[Guidelines for creating JavaScript modules]

## Creating the worker
[Steps for creating the JavaScript worker instance]

## Properties
[List and description of available properties]

## Methods
### Called Methods
[List and description of methods that can be called]

### Callback Methods
[List and description of callback methods]

## Example: Adding ZIP support
[A practical example demonstrating how to add ZIP support]
```

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

### Launch Task Instance Using Notation

Source: https://www.omnis.net/developers/resources/support/newsletter/may_05

Launches a new task instance using the '$open()' method with the task class notation. This method accepts an optional instance name and an optional parameter list for the _$construct_ method. An empty first parameter or '*' can be used to let Omnis Studio generate a unique instance name. Parameters are passed as an array.

```Omnis JavaScript Notation
Do $clib.$tasks.<classname>.$open([instancename],[<parameter                list>])
```

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

### JavaScript Component SDK - Tutorial

Source: https://www.omnis.net/developers/resources/onlinedocs/ExtcompSDK/00intro

Guides for building and running generic components and extending them using C++ or JavaScript.

```APIDOC
## JavaScript Component SDK - Tutorial

### Building Generic Components
Instructions on how to build generic C++ components and JavaScript controls.

### Running Generic Components
Steps for running the developed generic components.

### Extending Generic Components
Guidance on extending generic components using different approaches, including 'Generic 2' and 'Generic 3'.
```

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

### Python Worker Object

Source: https://www.omnis.net/developers/resources/onlinedocs/index_detail=ExtendingOmnis%2F00about.html

Explains the Python Worker Object for integrating Python scripts into Omnis, covering installation, setup, method calling, and error handling.

```APIDOC
## Python Worker Object

### Description
The Python Worker Object enables the seamless integration of Python scripts within Omnis applications. This documentation covers the installation process, setting up a Python worker, calling Python methods from Omnis, and strategies for error handling.

### Method
N/A (Conceptual Documentation)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Omnis Studio Commands: Remote Studio Applet Examples

Source: https://www.omnis.net/developers/resources/onlinedocs/index_detail=CommandRef%2Findex.html

This section lists examples of using the Remote Studio Applet with Visual Basic and Omnis Studio, demonstrating the use of server applets and complex variables.

```OmnisScript
# Use of the Server applet in Visual Basic
# Use of the complex variables and Server applet in Omnis Studio
# Use of the Server applet in PHP
```

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

### JavaScript Component SDK - Tutorial

Source: https://www.omnis.net/developers/resources/onlinedocs/Programming/16Datafilemigration

Guides on building and running generic C++ and JavaScript components using the SDK.

```APIDOC
## JavaScript Component SDK - Tutorial

### Description
This tutorial guides users through building and running generic C++ and JavaScript components, providing practical examples and steps.

### Building Generic Components
- **C++ Component**: Instructions for building C++ components.
- **The JavaScript Control**: Instructions for building JavaScript controls.

### Running Generic Components
- **Running Generic**: Steps to execute the built components.

### Extending Generic Components
- **Generic 2**: Extending functionality with Generic 2.
- **Generic 3**: Extending functionality with Generic 3.

### Debugging
- **Debugging a Component**: Techniques for debugging components.
- **Debugging a Control**: Techniques for debugging controls.

```

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

### Python Worker Object

Source: https://www.omnis.net/developers/resources/onlinedocs/index_detail=AppFramework%2F00usage.html

Guide to setting up and using the Python Worker Object, including installation, method calls, and error handling.

```APIDOC
## Python Worker Object

### Description
Instructions on installing and setting up the Python Worker Object, calling Python methods, and handling errors.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```
Tokens:
Raw