Omnis Programming

Omnis Software Ltd

Released May 2023
Updated Jun 2023 Revision 35439
Updated Oct 2023 Revision 35659

About This Manual

This manual starts with a general introduction to the Omnis Environment and goes onto to describe Libraries and Classes. It then focuses on all aspects of Programming and Debugging code in Omnis Studio, including information about creating and using List Variables, accessing and managing SQL databases, as well as describing the Omnis VCS. To learn more about creating web and mobile applications, you need to refer to the Creating Web & Mobile Apps manual.

In addition, there are the Omnis Reference manuals containing information about all the Commands and Functions available in Omnis Studio, plus there is a comprehensive Help system, available from within the Omnis IDE using the F1 key, which contains a complete list of all Omnis Notation including all properties and methods.

The majority of the information in this manual is relevant if you are using the Community Edition, except the chapters on Window Classes and Window Components which are used for creating desktop apps and are therefore not available in the Community Edition.

If you are new to Omnis

When you start Omnis Studio you will see the Studio Browser (if this is not visible press F2 on Windows or Cmnd-2 on macOS) which allows you to create a new project library or open an existing library. Under the Hub section, you can look at example Omnis applications under the Applets and Samples options: you can open each example in your web browser or within Omnis itself, and you can examine the Omnis code in the associated library under the Project Libraries option in the Studio Browser. Some of the example code in this manual is taken from the example applications in the Hub.

In addition to looking at the example applications in the Hub, you may like to work through the Tutorial which covers all the main tasks in creating an application in Omnis Studio, including creating SQL data classes, logging onto a SQL database, and building remote forms.

The software this document describes is furnished under a license agreement. The software may be used or copied only in accordance with the terms of the agreement. Names of persons, corporations, or products used in the tutorials and examples of this manual are fictitious. No part of this publication may be reproduced, transmitted, stored in a retrieval system or translated into any language in any form by any means without the written permission of Omnis Software.
© Omnis Software, and its licensors 2023. All rights reserved.
© 1999-2023 The Apache Software Foundation. All rights reserved.
This product includes software developed by the Apache Software Foundation (
Specifically, this product uses Json-smart published under Apache License 2.0 (
© 2001-2023 Python Software Foundation; All Rights Reserved.
The iOS application wrapper uses UICKeyChainStore created by and governed by the MIT license.
Omnis® and Omnis Studio® are registered trademarks of Omnis Software.
Microsoft, MS, MS-DOS, Visual Basic, Windows, Windows Vista, Windows Mobile, Win32, Win32s are registered trademarks, and Windows NT, Visual C++ are trademarks of Microsoft Corporation in the US and other countries.
Apple, the Apple logo, Mac OS, Macintosh, iPhone, and iPod touch are registered trademarks and iPad is a trademark of Apple, Inc.
IBM, DB2, and INFORMIX are registered trademarks of International Business Machines Corporation.
UNIX is a registered trademark in the US and other countries exclusively licensed by X/Open Company Ltd.
Oracle, Java, and MySQL are registered trademarks of Oracle Corporation and/or its affiliates
SYBASE, Net-Library, Open Client, DB-Library and CT-Library are registered trademarks of Sybase Inc.
Acrobat is a registered trademark of Adobe Systems, Inc.
CodeWarrior is a trademark of Metrowerks, Inc.
This software is based in part on the work of the Independent JPEG Group.
This software is based in part of the work of the FreeType Team.
Other products mentioned are trademarks or registered trademarks of their corporations.