What is Omni Automation?

A short description of Omni Automation.

Welcome to OMNI-AUTOMATION.COM, a resource for information about the device-independent automation support in the apps from the Omni Group. (Follow us on Mastodon!)

Overview

“Omni Automation” is the name of the comprehensive user-controlled automation tools included with the productivity suite of applications from the Omni Group: OmniGraffle, OmniOutliner, OmniPlan, and OmniFocus.

Using the Core JavaScript frameworks included with every Apple device, Omni Automation “scripts” offer the same syntax and functionality across all Apple platforms (iOS, iPadOS, and macOS). For example, a JavaScript script written to automate an OmniFocus process will execute the same regardless of which Apple device is hosting the application.

In addition, Omni Automation provides built-in tools for communicating with other Omni and 3rd-party applications, using standard “URL callbacks;” integrated HTTP-Request support for accessing remote sources via RESTful APIs; reading and writing XML data; responsive Speech Synthesis; and the secure storage of password credentials in Apple’s System Keychain.

To maximize portability, Omni Automation scripts can be used in the provided Omni actions for Apple’s Shortcuts application, and also be saved as text-based “Plug-Ins” installable by the user and which may be shared between devices via iCloud and 3rd-party internet storage integration.

Uniquely, any Omni Automation script can also be expressed as a URL, enabling “interactive links” in webpages and documents, and direct integration with Apple’s Assistive technologies such as Voice Control, delivering the ability to automate Omni applications using your voice!

And to enhance interaction with the automation user, both Omni Automation Plug-Ins and Script URLs can present standard application interfaces, like text fields, checkboxes, and menus, to enable the user to provide input to best guide the automation as it processes data and automates application features.

Omni Automation is…

included with each Omni application, covering nearly all application features, and is supported by extensive API documentation available on this website.
Uses the Core JavaScript component of the open-source WebKit frameworks, one of the most widely used, documented, and optimized scripting languages there is.
user-configurable and user-installable. Omni Automation plug-ins may be shared between devices and platforms using shared internet services such as DropBox and Apple’s iCloud Drive.
compatible with 3rd-party applications that support JavaScript and standard URL callbacks.
compatible with 3rd-party web-services that provide RESTful APIs, with built-in support for plug-in preferences and Keychain Credentials for securely storing login and password data.
designed to interact fully with the Shortcuts automation workflows application, which is included by default with iOS, iPadOS, and macOS.
text-based. Although each Omni application includes a built-in console for writing and running user-input scripts, Omni Automation is fully compatible with 3rd-party code editing applications, which can be used to author the automation action files.
a community of motivated users who use Omni Automation to create and distribute custom productivity tools for automating both common and uncommon processes and procedures.

LINKS

ⓘ To navigate to the various pages of this section, use the Navigation Overlay that can be summoned via the navigation overlay menu (☰ <- top left of this page). Additionally, the Navigation Overlay may be summoned/dismissed using these keyboard shortcuts: Control-Option-N (⌃⌥N) and Control-Option-C (⌃⌥C)

Omni Applications:

Shared Essentials:

Script Security
Console
Script URLs
Plug-Ins and Libraries
Simple Plug-In Generators
Shared Classes & Methods (includes Fetch API)

Extended Automation:

Interoperability:

DuckDuckGo Omni-Automation Site Search:

LICENSE/DISCLAIMER

PERMISSION IS HEREBY GRANTED, FREE OF CHARGE, TO ANY PERSON OBTAINING A COPY OF THIS SOFTWARE AND ASSOCIATED DOCUMENTATION FILES (THE "SOFTWARE"), TO DEAL IN THE SOFTWARE WITHOUT RESTRICTION, INCLUDING WITHOUT LIMITATION THE RIGHTS TO USE, COPY, MODIFY, MERGE, PUBLISH, DISTRIBUTE, SUBLICENSE, AND/OR SELL COPIES OF THE SOFTWARE, AND TO PERMIT PERSONS TO WHOM THE SOFTWARE IS FURNISHED TO DO SO, SUBJECT TO THE FOLLOWING CONDITIONS:

THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE.

SOFTWARE AND EXAMPLES ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

IN NO EVENT SHALL OMNI-AUTOMATION.COM BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES ( INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION ) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND / OR DISTRIBUTION OF THE OMNI-AUTOMATION.COM SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT ( INCLUDING NEGLIGENCE ), STRICT LIABILITY OR OTHERWISE, EVEN IF OMNI-AUTOMATION.COM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Mention of third-party websites and products is for informational purposes only and constitutes neither an endorsement nor a recommendation. OMNI-AUTOMATION.COM assumes no responsibility with regard to the selection, performance or use of information or products found at third-party websites. OMNI-AUTOMATION.COM provides this only as a convenience to our users. OMNI-AUTOMATION.COM has not tested the information found on these sites and makes no representations regarding its accuracy or reliability. There are risks inherent in the use of any information or products found on the Internet, and OMNI-AUTOMATION.COM assumes no responsibility in this regard. Please understand that a third-party site is independent from OMNI-AUTOMATION.COM and that OMNI-AUTOMATION.COM has no control over the content on that website. Please contact the vendor for additional information.