Installing Omni Automation Plug-Ins

Omni Automation Plug-Ins and solitary actions are designed to be easily installed and accessed. The following documentation details how to add Omni Automation Plug-Ins to your applications, on both macOS and iOS.

Installing Plug-Ins on macOS

On macOS, Omni Automation Plug-Ins are installed by placing their files within the designated application support folders for each Omni application. To open an Omni application’s Plug-Ins folder, select “Plug-Ins…” from the application’s Automation menu (see below):

The Automation Menu

…and the Plug-Ins folder for the application will be opened on the desktop (see below). Place Omni Automation Plug-In bundles  1  and Omni Automation solitary action files  2  in this folder.

NOTE: Plug-In bundles have a file extension of “the name of Omni application” combined with “js” (.omnigrafflejs, .omnioutlinerjs, etc.), while solitary action files have a file extension of “.omnijs” (see below)

The Automation Menu

Once installed, Omni Automation Plug-Ins will display as sub-menus  1  and solitary actions will display as a single menu item  2  (see below)

The Automation Menu

Installing Plug-Ins on iOS

On iOS, Omni Automation Plug-Ins can be installed in a variety of ways:

Let’s examine these methods.

Send Plug-In via AirDrop from other macOS or iOS device

Before attempting to transfer a Plug-In, make sure that AirDrop is enabled on the receiving iOS device in the iOS Control Center (see below)

iOS Control Center with AirDrop active

When the AirDrop session is initiated on the sending device, a confirmation notice will appear on the receiving device:

AirDrop confirmation dialog

Tap the “Accept” button to begin the installation process, which will present a list of applications. Choose the application in which to install the Plug-In (in this example, the target application is OmniGraffle):

A list of apps for installation

Tap the name of the app to receive the Plug-In (in this example, it’s OmniGraffle). A confirmation dialog will be displayed showing information about the Plug-In. The dialog also displays a security warning reminding that since Plug-Ins may contain powerful JavaScript code, Plug-Ins should only be installed from trusted sources.

Screenshot

Tap the “Install” button at the bottom right of the dialog to install the Plug-In in the Omni app. Next, tap the “Plug-Ins” button in the app’s resource navigation menu (below):

app resources navigation bar

and icons for all of the installed Plug-Ins will be displayed:

Installed Plug-Ins

NOTE: within the Plug-In view you can choose to uninstall a Plug-In by selecting in the list, and tapping the trash icon:

Screenshot

Install Plug-In from Webpage Link

On iOS, the installation process for Omni Automation Plug-Ins can begin with the user tapping on a webpage link to an Omni Automation Plug-In file or ZIP archive of a Plug-In file.

For example, the following link is to a ZIP archive containing a solitary-action Plug-In for OmniGraffle. When installed, it will change the fill color of selected graphics to red.

setFillToRed.omnijs.zip

when the link to the Plug-In archive is tapped, a view displaying information about ZIP file will be displayed. Do not tap “Open in OmniGraffle” as the app will attempt to read the archive as a file, not as a Plug-In. Instead, tap the “More…” option:

ZIP file dialog

And then tap the “Copy to OmniGraffle” icon to begin the previously detailed Plug-In installation process in OmniGraffle.

Copy to OmniGraffle

Install Plug-In from eMail

As with webpage links, a tap on the icon of the sent Plug-In file summons a dialog in which you choose the “Copy to OmniGraffle” option to begin the installation process:

Installing plugin from email

The Omni Automation Website “Install Plug-In” Button

Some of the Omni Automation script examples contained on this website include an “Install Plug-In” button at the top of the code view for the script.

TAP|CLICK these buttons (on iOS or macOS) and follow the provided instructions to install the provided Plug-In or library file.

For example, here is the code for an OmniGraffle Plug-In that will set the fill color of every selected graphic to red. TAP|CLICK the “Install Plug-In” to install it on your device:

/*{ "type": "action", "targets": ["omnigraffle"], "author": "Otto Automator", "identifier": "com.omni-automation.omnigraffle.setFillToRed", "description": "This action will set the fill color of the selected graphics to red.", "label": "Set Fill to Red", "paletteLabel": "Red Fill" }*/ var _ = function(){ var action = new PlugIn.Action(function(selection, sender){ // action code // selection options: canvas, document, graphics, lines, solids, view selection.graphics.forEach(function(graphic){ graphic.fillColor = Color.red }) }); action.validate = function(selection, sender){ // validation code // selection options: canvas, document, graphics, lines, solids, view if(selection.graphics.length > 0){return true} else {return false} }; return action; }(); _;
UNDER CONSTRUCTION

This webpage is in the process of being developed. Any content may change and may not be accurate or complete at this time.

DISCLAIMER