Welcome to the introductory tutorial for learning about Omni Automation in the OmniFocus application from The Omni Group.
This step-by-step guide will introduce you to the power and abilities of the device-independent JavaScript scripting implementation in OmniFocus (called Omni Automation) and in a short time, get you on the path to creating your own automation tools.
You’ll find that a general knowledge of the basics of the JavaScript language will be useful to acquire prior to exploring this tutorial, as the following lessons assume you have experience with fundamental concepts, objects, functions, and methods of the JavaScript language.
Fortunately, JavaScript is one of the most widely documented technologies there is and you’ll find no shortage of excellent instructional materials. For example, here are a few of the many online resources available for you:
Once you’ve gained some understanding of the basics of the JavaScript language, you’re ready to proceed with this tutorial.
ⓘ 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)
One more thing…
This tutorial uses special script links to interact directly with your copy of OmniFocus. Visit the “Script Security” page to learn how to enable the execution of remote scripts (like those from this website) in an Omni application. Once enabled, you’re ready to proceed with learning how to automate OmniFocus!
var matchedProjects = flattenedProjects.filter(project => {return project.name === "OmniFocus Tutorial"})
console.log(matchedProjects)
if(matchedProjects.length === 0){
var project = new Project("OmniFocus Tutorial")
project.task.sequential = true
project.completedByChildren = true
var tutorialTopics = [{"title":"Introduction","page":"index.html"},{"title":"Console","page":"console.html"},{"title":"Inbox","page":"inbox.html"},{"title":"Due and Repeat","page":"task.html"},{"title":"Tags","page":"tag.html"},{"title":"Projects","page":"project.html"},{"title":"Plug-Ins","page":"plug-in.html"},{"title":"Cleanup and Restore","page":"cleanup.html"}]
var baseURL = "https://omni-automation.com/omnifocus/tutorial/"
tutorialTopics.forEach(topicObj => {
var tsk = new Task(topicObj.title,project)
tsk.note = baseURL + topicObj.page
})
var projectID = project.task.id.primaryKey
URL.fromString("omnifocus:///task/" + projectID).open()
} else {
var projectID = matchedProjects[0].task.id.primaryKey
URL.fromString("omnifocus:///task/" + projectID).open()
var alertMsg = "A project named “OmniFocus Tutorial” already exists."
new Alert("Existing Project",alertMsg).show()
}
TRY THIS! Use Omni Automation to install a new project in the OmniFocus database on this device, to assist you in keeping track of your progress with this tutorial!
