Differences

This shows you the differences between two versions of the page.

--- action:Execute_an_AppleScript [2017/03/14 05:01]
peternlewis
+++ action:Execute_an_AppleScript [2019/11/26 21:57]
peternlewis [Scripting]
@@ Line 1: / Line 1: @@
-{{:scripting-icon.png?nolink|}}
 ====== Execute AppleScript Action ======
-The Execute an AppleScript action executes a specified AppleScript, either from a file or text. For example, say "hello".
+The Execute an AppleScript action executes a specified AppleScript, either from a file or text.
-The results of an AppleScript can be:
+===== Setup =====
-  *Ignored.
+When you insert an //Execute AppleScript// Action, it will appear as shown below.\\
-  *Displayed in a floating window.
-  *Displayed briefly in a Notification.
+{{:action:execute-applescript-km8.png?nolink|}}
-  *Typed in to the current selection.
-  *Pasted in to the current selection.
+**There are two setup options:**
-  *Saved to a variable.
+^ Setup Option ^ Choices\\ (Default shown first) ^
-  *Saved to the system or a Named Clipboard.
+| Script location | Execute text script (type or paste script into Action text field)\\ Execute script file (This is faster if it is a compiled script file `.scpt`) |
-  *Asynchronously ignored — the action runs while the macro continues on.
+| Script Results | Ignored.\\ Displayed in a floating window.\\ Displayed briefly in a Notification.\\ Typed in the current text field that has focus.\\ Pasted in text field that has focus.\\ Saved to a Keyboard Maestro Variable.\\ Saved to the System or Named Clipboard.\\ Ignore Results and run //Asynchronously// (the script runs while the macro immediately continues on to the next //Action//.) |
+Here is a typical example with these options:
+  - **Script location**: //Execute text script//
+  - **Script Results**: //save results to variable//
+    * This causes the //Save to variable// field to appear at the bottom
+    * Since this variable is not needed after the macro finishes, a //Local// variable is used.
+    * While the script can set Keyboard Maestro Variables, it is generally better to just return the result from the script, then allow the user to choose the Variable.
+{{:action:execute-applescript-example-km8.png?nolink|}}
+If the script fails, the action will fail (v9.0+), potentially aborting the macro.
 ===== Scripting =====
 For the latest update on this topic, see the User Manual article: [[manual:Scripting|Scripting]].
 This provides the latest method to get and set Keyboard Maestro variables via AppleScript.
-AppleScripts are executed in the background via osascript. This means they are not allowed to do user interaction. You can work around this by asking an application like System Events to do the user interaction for you, for example:
+AppleScripts are executed in the background via osascript. This means they are not allowed to do user interaction. You can work around this by asking the current applicationto do the user interaction for you, for example:
-  tell application "System Events"
+```applescript
-    activate
+tell application "System Events"
-    display dialog "Hello"
+  set currentAppName to name of first application process whose frontmost is true
-  end tell
+end tell
+tell application currentAppName
+  display dialog "Your message here" with title "Your Title here"
+end tell
+```
 ===== Using Keyboard Maestro Variables =====
-:!: **See [[manual:Scripting|Scripting]] for best methods.**
+:!: **See [[:AppleScript|Using AppleScript to Get and Set Keyboard Maestro Variables]] for best methods.**
+In AppleScript with Keyboard Maestro Version 7.1+, you can tell the application "Keyboard Maestro Engine" to:
+    getvariable <KM Variable Name>
+    setvariable <KM Variable Name> to <New Value>
+where both the `<KM Variable Name>` and `<New Value>` are text values.
+For example:
+<code applescript>
+tell application "Keyboard Maestro Engine" to set myVar to getvariable "My KM Variable"
+</code>
 **Using Keyboard Maestro Variables in a Shell Script from AppleScript**
@@ Line 39: / Line 68: @@
 set myVar to do shell script "echo $KMVAR_My_KM_Variable"
 </code>
-However, if setting an AppleScript Variable to a Keyboard Maestro Variable is all you needed to do, then you would use this (requires Ver 7.1+):
-<code applescript>
-tell application "Keyboard Maestro Engine" to set myVar to getvariable "My KM Variable"
-</code>

Keyboard Maestro Wiki

User Tools

Site Tools

Differences

Page Tools