Power Manager Terminology - Open Scripting Architecture Reference

application #

The application's top-level scripting object.

Properties

• name (text / read-only) The name of the application.
• frontmost (boolean / read-only) Is this the active application?
• version (text / read-only) The version number of the application.

document #

A document.

Properties

• name (text / read-only) Its name.
• modified (boolean / read-only) Has it been modified since the last save?
• file (file / read-only) Its location on disk, if it has one.

window #

A window.

Properties

• name (text / read-only) The title of the window.
• id (integer / read-only) The unique identifier of the window.
• index (integer / read and write) The index of the window, ordered front to back.
• bounds (rectangle / read and write) The bounding rectangle of the window.
• closeable (boolean / read-only) Does the window have a close button?
• miniaturizable (boolean / read-only) Does the window have a minimize button?
• miniaturized (boolean / read and write) Is the window minimized right now?
• resizable (boolean / read-only) Can the window be resized?
• visible (boolean / read and write) Is the window visible right now?
• zoomable (boolean / read-only) Does the window have a zoom button?
• zoomed (boolean / read and write) Is the window zoomed right now?
• document (document / read-only) The document whose contents are displayed in the window.

connection #

A connection.

Properties

• name (text / read-only)
• authenticated (boolean / read-only)
• client (Client API / read-only) Host device details.

  The Scheduler provides a selection of host details to help identify and group clients.

• time zone (Time Zone API / read-only) Local time zone details

  The time zone of the client is useful to know in order to present dates and times in an appropriate format for remote users.

• power (Power API / read-only) Power source details.

  Power details the host computer’s power sources and each of those sources’ state. If the computer only supports AC/mains, there may not be any power sources.

• authorisation (Authorisation API / read-only) Authorisation control for requests and functionality.

  Authorisation determines who can and can not access specific requests and functionality within the engine. By default, authorisation is tightly associated with the calling user’s role within the operating system.

• astronomic (Astronomic API / read-only) Astronomical calculator.

  Calculations are performed using the Astronomic Algorithms Plus (AA+) library by PJ Naughter.

• audio (Audio API / read-only) Device audio settings.

  Audio provides access to both the system default audio output device and the default audio device. Often these two devices will be the same.

• event store (Event Store API / read-only) Stores, organises, and tracks events.

  Event Store is the storage of the Scheduler. All events are stored in Event Store.

  Use the Event Store to add and remove events. Event history is available for recently triggered or performed events.

  Changes to the contents of the Event Store will be reflected in the Scheduler and other Scheduler objects.

• scheduler (Scheduler API / read-only) Coordinates the events, triggers, conditions, and actions.

  The Scheduler object is the core of Power Manager’s Schedule. All events, triggers, conditions, and actions are managed through the Scheduler.

  Use the Scheduler to add and remove events. The Scheduler provides requests to atomically set multiple events, and a request to disable all events from being triggered.

• on demand (On Demand API / read-only) On demand events can be performed immediately.

  On Demand manages events that can be performed immediately. Determining events that can be performed immediately is not trivial, and this object exists to help isolate you from that task.

• notifications (Notifications API / read-only) All pending events and their notifications.

  Notifications provides ordered lists of current, pending, and warning events and their triggers or actions.

  Notifications also provides requests to adjust events with time and date triggers. These triggers can be adjusted and cancelled through Notifications.

• build (Build API / read-only) Scheduler meta-data.

  Build provides build details and control.

• legal (Legal API / read-only) Legal and licensing details.
• listen (Listen API / read-only) Configures and controls incoming network connections.

  Listen manages the push behaviour of the Scheduler.

  In a push environment, schedules are sent to the Scheduler from the server. The connection from server to Scheduler is instigated by the server as needed.

  Listen provides a means for configuring the Scheduler remotely.

local workshop #

A workshop for creating, editing, and storing objects.

environment variable #

Environment variable.

Properties

• id (text / read and write) Name of the environment variable.
• value (text / read and write) Value of the named variable.

resource limits #

Constraints for external processes.

Properties

• core size (integer / read and write) Largest size core file that may be created.

  In BSD’s setrlimit call this field maps to RLIMIT_CORE. core size is measured in bytes.

• CPU time (integer / read and write) Maximum amount of CPU time to be used.

  In BSD’s setrlimit call this field maps to RLIMIT_CPU. CPU time is measured in seconds.

• data segment (integer / read and write) Maximum size of the data segment.

  In BSD’s setrlimit call this field maps to RLIMIT_DATA. data segment is measured in bytes.

• file size (integer / read and write) Largest size file that may be created.

  In BSD’s setrlimit call this field maps to RLIMIT_FSIZE. file size is measured in bytes.

• memory lock (integer / read and write) Maximum size of memory that may be locked using mlock.

  The mlock function is used to lock physical pages of memory. This means those pages can not be swapped to disk by virtual memory.

  In BSD’s setrlimit call this field maps to RLIMIT_MEMLOCK. memory lock is measured in bytes.

• number of files (integer / read and write) Maximum number of open files.

  Be careful limiting the number of open files an external process can open. Processes often need more files than even the developer expects. Open files include the three standard files:

  • standard in;
  • standard out;
  • standard error.

  Open files are also needed to make use of macOS frameworks and other linked-at-runtime resources. Use the command line tool lsof to examine what processes have what files open.

  In BSD’s setrlimit call this field maps to RLIMIT_NOFILE.

• number of processes (integer / read and write) Maximum number of simultaneous processes for this user id.

  In BSD’s setrlimit call this field maps to RLIMIT_NPROC.

• resident set size (integer / read and write) Maximum amount of physical memory.

  The maximum size to which a process’s resident set size may grow. This limits the physical memory provided to the external process but it does not restrict the virtual memory.

  In BSD’s setrlimit call this field maps to RLIMIT_AS / RLIMIT_RSS. resident set size is measured in bytes.

• stack size (integer / read and write) Maximum size of the stack segment.

  In BSD’s setrlimit call this field maps to RLIMIT_STACK. stack size is measured in bytes.

external #

Description for executing an external process.

Properties

• type (external type / read and write) Type of external being described.
• arguments (list of text / read and write) Arguments to pass to the executable.
• user (text / read and write) User to execute process as.

  Short user name.

• group (text / read and write) Group to execute process as.

  Short group name. If no group is provided, the primary group of the user is used.

• root directory (text / read and write) Set the executable's root directory (chroot).
• working directory (text / read and write) Set the executable's working directory (chdir).

  Relative paths are resolved with respect to any root directory.

• redirect standard out (text / read and write) Redirect the executable's standard output (stdout) to a file.

  An absolute path to which the executable’s output to appended. The file is created as needed. Removing the file while the executable is running will cause undefined behaviour.

• redirect standard error (text / read and write) Redirect the executable's standard error (stderr) to a file.

  An absolute path to which the executable’s error to appended. The file is created as needed. Removing the file while the executable is running will cause undefined behaviour.

• process scheduling priority (integer / read and write) Set the executable's scheduling priority (nice).
• throttle disk reads (boolean / read and write) Throttle the executable's disk reads.
• file creation mode mask (integer / read and write) Set the executable's file creation mode mask (umask).
• soft resource limits (resource limits / read and write) Set the executable's soft resource limits.
• hard resource limits (resource limits / read and write) Set the executable's hard resource limits.

external executable #

Execute the external executable.

Inherits from external

Properties

• executable (text / read and write) Absolute path to the executable.

  Executable to be executed as an absolute path to an existing file. The file must be readable and executable.

• type (external type / read-only) Type of external being described.

  This is marked as hidden and may be deprecated or not designed for public use.

external inline #

Execute the inline content.

Inherits from external

Properties

• inline (text / read and write) Inline content to write to disk and execute.

  inline is typically a shell script or other language.

• encoding (encoding / read and write) Encoding format used by inline.

  Encoding is typically ‘UTF-8 no BOM’ but may be provided in another format.

• type (external type / read-only) Type of external being described.

  This is marked as hidden and may be deprecated or not designed for public use.

sample criterion #

Criterion for concluding a sample.

Properties

• type (sample criterion type / read and write) Type of criterion to apply.
• value (integer / read and write) Value to compare samples with.
• result (boolean / read and write) Result to publish, if criterion is met.

sample criterion equal #

Judge the samples looking for a positive match.

Inherits from sample criterion

Properties

• type (sample criterion type / read-only) Type of criterion to apply.

  This is marked as hidden and may be deprecated or not designed for public use.

sample criterion not equal #

Judge the samples looking for a negative match.

Inherits from sample criterion

Properties

• type (sample criterion type / read-only) Type of criterion to apply.

  This is marked as hidden and may be deprecated or not designed for public use.

external criterion #

Criterion for judging an external executable sample.

Properties

• type (external criterion type / read and write)

external criterion interpret #

Interpret the output as a number.

Inherits from external criterion

Properties

• source (external files / read and write) Sources to interpret.

  Output sources to interpret. Up to 16KB of content is retained from the external’s stdout and stderr stream. The content is taken from the final bytes output; much like the tail command line tool.

• type (external criterion type / read-only)

  This is marked as hidden and may be deprecated or not designed for public use.

external criterion contains #

Output contains a value.

Inherits from external criterion

Properties

• source (external files / read and write) Sources to search.

  Output sources to search. Up to 16KB of content is retained from the external’s stdout and stderr stream. The content is taken from the final bytes output; much like the tail command line tool.

• value (text / read and write) Value to search for.
• type (external criterion type / read-only)

  This is marked as hidden and may be deprecated or not designed for public use.

sample #

Description for sampling.

Properties

• source (source type / read and write) Source of samples.
• initial delay (integer / read and write) Delay before sampling begins in seconds.
• frequency (integer / read and write) Frequency of sampling in seconds.

  Duration between samples.

• window (integer / read and write) Sample window to evaluate.

  The number of historic samples to use when determining if the criteria has been met. The window represents a collection of the latest samples gathered. As samples leave the window they are released and will not be used in any future evaluations.

  No evaluation will occur until enough samples have been collected to fill the window.

• limit (integer / read and write) Seconds after sampling begins that it is stopped.

  Maximum duration of sample process.

  If the sampling has not reached a result and limit’s duration has passed since sampling begun, stop the sampling. Limit provides a time constraint on the sampling process.

sample execute external #

Sample from an external executable.

Inherits from sample

Properties

• external (external / read and write) external to launch.

  Details of the external executable to launch.

• external criterion (external criterion / read and write) Criterion to judge external executable by on exit.
• source (source type / read-only) Source of samples.

  This is marked as hidden and may be deprecated or not designed for public use.

application description #

Description for launching an external process.

Properties

• path (text / read and write) Absolute path to the application.

  If the application is a bundle, the path must refer to the top level of the bundle.

• open (list of text / read and write) Absolute file paths to open.

  If the application path is omitted, each file is opened with the appropriate application.

• arguments (list of text / read and write) Arguments to pass to the application.
• user (text / read and write) User to execute process as.

  Short user name.

• visibility (application visibility / read and write) Is the application visible after launch.
• behaviours (list of application behaviour / read and write) Application behaviours.

  Behaviours affecting how the application is launched.

power source #

A power source.

Properties

• type (power source type / read and write) Connection type of power source.
• name (text / read and write) Name of the power source.
• state (power state / read and write) Is the power source available and in use.
• present (boolean / read and write) Is the power source present.
• health (power health / read and write) Is the power source is good health.

  Power sources such as batteries degrade with age and use. Some power sources are able to detect this process and provide a guide as to the health of the battery.

• confidence (power confidence / read and write) Is the health field accurate.
• current capacity (integer / read and write) Current percentage capacity.
• charging (boolean / read and write) Is the power source being charged.
• seconds remaining (integer / read and write) Estimated seconds remaining until fully charged or empty.

  If the power source is being charged, the seconds remaining refer to the time remaining until fully charged.

  If the power source is being used, the seconds remaining refer to the time remaining until the power source is empty.

  This value may not be present for all power sources.

power source serial #

Power source connected via a serial cable.

Inherits from power source

Properties

• type (power source type / read-only) Connection type of power source.

  This is marked as hidden and may be deprecated or not designed for public use.

power source USB #

Power source connected via a USB cable.

Inherits from power source

Properties

• type (power source type / read-only) Connection type of power source.

  This is marked as hidden and may be deprecated or not designed for public use.

power source network #

Power source connected via a network connection.

Inherits from power source

Properties

• type (power source type / read-only) Connection type of power source.

  This is marked as hidden and may be deprecated or not designed for public use.

power source internal #

Internal power source such as a fitted or removable battery.

Inherits from power source

Properties

• type (power source type / read-only) Connection type of power source.

  This is marked as hidden and may be deprecated or not designed for public use.

power source unknown #

Unknown power source.

Inherits from power source

Properties

• type (power source type / read-only) Connection type of power source.

  This is marked as hidden and may be deprecated or not designed for public use.

power source filter #

A profile for filtering power source changes.

Properties

• transport type (power source type / read and write) Trigger only if the power source's type matches.

  Use this field to filter power sources by their connection to the host computer. By specifying a transport type of network, only changes to network connected power sources will trigger the trigger.

• name (text / read and write) Trigger only if the power source's name matches.
• comparison (comparison / read and write) How should the name be compared to the power source name.
• options (list of comparison option / read and write) Comparison options allowing fine control over the comparison method.
• charging (boolean / read and write) Trigger only if the power source's charging matches.

geolocation #

Geospatial location.

Properties

• latitude (real / read and write) Latitude to calculate sun position from.

  Calculate sun position relative to this location on the planet.

• longitude (real / read and write) Longitude to calculate sun position from.

  Calculate sun position relative to this location on the planet.

notification context value #

Notification context value.

Properties

• id (text / read and write) Name of the value.
• value (text / read and write) Value of the named variable.

process signature #

Process signature provides a robust means of identifying a running process.

Properties

• type (process signature type / read and write) Type of process signature.

  A process can be identified using a range of methods. The type determines which method is used.

• comparison (comparison / read and write) How should the process signature be compared.
• options (list of comparison option / read and write) Comparison options allowing fine control over the comparison method.

process signature bundle identifier #

Match a process's bundle identifier.

Inherits from process signature

Properties

• bundle identifier (text / read and write) Bundle identifier to compare to the process.
• type (process signature type / read-only) Type of process signature.

  This is marked as hidden and may be deprecated or not designed for public use.

  A process can be identified using a range of methods. The type determines which method is used.

process signature name #

Match a process's bundle or executable name.

Inherits from process signature

Properties

• name (text / read and write) Bundle or executable name to compare to the process.

  Name to compare against the process’s bundle name. If the process is not bundled, the name is compared to the process’s executable name.

• type (process signature type / read-only) Type of process signature.

  This is marked as hidden and may be deprecated or not designed for public use.

  A process can be identified using a range of methods. The type determines which method is used.

process signature localised name #

Match a process's localised name.

Inherits from process signature

Properties

• localised name (text / read and write) Localised name to compare to the process.
• type (process signature type / read-only) Type of process signature.

  This is marked as hidden and may be deprecated or not designed for public use.

  A process can be identified using a range of methods. The type determines which method is used.

trigger #

Description of an external event or potential change in state to watch.

Properties

• type (trigger type / read and write) Type of trigger being described.

trigger once #

Trigger once on a given time and date.

Inherits from trigger

Properties

• date (date / read and write) Date and time to trigger.

  date can be any time and date in the past or future. Dates in the past are not useful but not invalid as values.

• availability (power / read and write) Should the host be made available for this trigger.

  Ensure the computer is powered on.

• scatter (integer / read and write) Scatter the date.

  Randomly distribute trigger time.

• quiet (boolean / read and write) Minimise the notifications.

  Reduce the notifications before the trigger occurs.

• drift (integer / read and write) Acceptable drift.

  Additional time for the computer to be ready.

• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

trigger daily #

Trigger at a given time on given days of the week.

Inherits from trigger

Properties

• seconds from midnight (integer / read and write) Seconds past midnight to trigger.

  Trigger at this time each selected day.

  The trigger’s time is measured in seconds from midnight. Where 0 seconds equals midnight.

  Calculate seconds from midnight using the following formula:

  • seconds from midnight = (hours x (60 x 60)) + (minutes x 60)
  • 5:30 am = (5 x (60 x 60)) + (30 x 60) = 19800 seconds from midnight
  • 2:23 pm = (14 x (60 x 60)) + (23 x 60) = 51780 seconds from midnight
• days (list of day / read and write) Days of the week to trigger.

  Trigger on these days of the week.

• availability (power / read and write) Should the host be made available for this trigger.

  Ensure the computer is powered on.

• scatter (integer / read and write) Scatter the date.

  Randomly distribute trigger time.

• quiet (boolean / read and write) Minimise the notifications.

  Reduce the notifications before the trigger occurs.

• drift (integer / read and write) Acceptable drift.

  Additional time for the computer to be ready.

• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

trigger after inactivity #

Trigger after a given period of user inactivity.

Inherits from trigger

Properties

• seconds of inactivity (integer / read and write) Period of inactivity needed before triggering.

  seconds of inactivity is measured in seconds.

• trigger limit (integer / read and write) Limit the frequency of repeating triggers.

  An inactivity trigger will fire whenever the inactivity timer is greater than the required seconds of inactivity field. If the event’s conditions postpone the event’s performance, the inactivity trigger is rescheduled and would to fire again immediately. The trigger limit provides a minimum number of seconds between inactivity triggers. Each trigger limit is applied per trigger instance.

  If the inactivity trigger has a value of 15 minutes, and a trigger limit value of 5 minutes, the event will triggered once after 15 minutes of inactivity and then every 5 minutes until activity occurs.

  If the trigger’s event is removed and added, or reset, the trigger limit’s behaviour is reset.

  If activity occurs, the trigger’s trigger limit behaviour is reset. If the inactivity trigger has a value of 15 minutes, and a trigger limit value of 30 minutes, the event will triggered once after 15 minutes of inactivity and then every 30 minutes. When activity occurs, the trigger limit will reset and the trigger will next fire after 15 minutes.

  The trigger limit is optional. If a value is not provided, the seconds of inactivity field is used instead. This behaviour provides the most commonly expected outcome.

  If a value of zero seconds is set, the inactivity trigger will not repeat until the inactivity timer has been reset.

• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

trigger notification #

Trigger on receiving a notification.

Inherits from trigger

Properties

• scope (scope / read and write) Observe notifications within this scope.

  Only notifications posted with the observed scope will cause the action to continue.

• notification (text / read and write) Notification to observe.

  Process wide notifications are posted as strings. Notifications should follow a reverse domain name format to avoid namespace collisions.

• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

trigger power on #

Trigger when the computer powers on.

Inherits from trigger

Properties

• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

trigger start up #

Trigger when the computer starts up.

Inherits from trigger

Properties

• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

trigger log in #

Trigger when a user logs in.

Inherits from trigger

Properties

• session type (user session type / read and write) Limit to user sessions of this type.
• session age (integer / read and write) Ignore sessions older that this duration.

  Avoid triggering for user sessions that are older this a given age.

  This cut off exists to deal with slow log in times and restarting of the Scheduler
  mid-session.
  
  The default is appropriate for most situations and the session age should be left empty.
  

• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

trigger log out #

Trigger when a user logs out.

Inherits from trigger

Properties

• session type (user session type / read and write) Limit to user sessions of this type.
• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

trigger user session time #

Trigger when a user session reaches a specific age.

Inherits from trigger

Properties

• session age (integer / read and write) Trigger when the user session reaches this age.
• session type (user session type / read and write) Limit to user sessions of this type.
• wake up (boolean / read and write) Wake up the computer from sleep when the session time is due.
• quiet (boolean / read and write) Minimise the notifications.

  Reduce the notifications before the trigger occurs.

• drift (integer / read and write) Acceptable drift.

  Additional time for the computer to be ready.

• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

trigger sleep #

Trigger when the computer is about to sleep.

Inherits from trigger

Properties

• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

trigger sample #

Trigger when a sample successfully concludes.

Inherits from trigger

Properties

• sample (sample / read and write) Sample to run to evaluate the environment.
• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

trigger power state #

Trigger when the source of power changes.

Inherits from trigger

Properties

• now (power state / read and write) New state of the power source.
• before (power state / read and write) Previous state of the power source.
• filter (power source filter / read and write) Power sources to monitor.
• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

trigger power remaining #

Trigger when the power remaining changes.

Inherits from trigger

Properties

• capacity (integer / read and write) Trigger when a power source reaches or passes this capacity.

  Capacity reaches or passes this percentage.

  A power source’s capacity may not increase and decrease in single units. The current capacity value may jump a few percentage points at a time. The trigger will fire when the current capacity equals or passes this capacity value.

  If the power source is being charged, the trigger will fire if the capacity equals or is greater than this capacity.

  If the power source is being used, the trigger will fire if the capacity equals or is less than this capacity.

  The trigger will only fire when the power source reaches or passes this capacity value.

• seconds remaining (integer / read and write) Trigger when a power source reaches or passes this duration remaining.

  Time remaining reaches or passes this duration.

• filter (power source filter / read and write) Power sources to monitor.
• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

trigger battery health #

Trigger when a power source's battery health changes.

Inherits from trigger

Properties

• now (power health / read and write) New health of the power source.
• before (power health / read and write) Previous health of the power source.
• filter (power source filter / read and write) Power sources to monitor.
• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

trigger sun #

Trigger at a given angle of the Sun.

Inherits from trigger

Properties

• moment (astronomical sun event / read and write) Astronomical Sun event to calculate.
• geolocation (geolocation / read and write) Location to calculate Sun position from.

  Calculate Sun position relative to this location on Earth.

• offset (integer / read and write) Offset from the calculated astronomical event.

  Offset the calculated time.

  Useful for creating triggers to occur some time before an astronomical event.

• availability (power / read and write) Should the host be made available for this trigger.

  Ensure the computer is powered on.

• scatter (integer / read and write) Scatter the date.

  Randomly distribute trigger time.

• quiet (boolean / read and write) Minimise the notifications.

  Reduce the notifications before the trigger occurs.

• drift (integer / read and write) Acceptable drift.

  Additional time for the computer to be ready.

• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

trigger external assistant #

Trigger when an external assistant changes.

Inherits from trigger

Properties

• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

trigger application #

Trigger when an application launches or quits.

Inherits from trigger

Properties

• process (process signature / read and write) Application to match.
• change (application change / read and write) Change in application to detect.
• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

trigger audio mute #

Trigger when an audio device mute state changes.

Inherits from trigger

Properties

• mute (boolean / read and write) Trigger when mute matches this value.
• audio device (audio device / read and write) Audio device to observe.
• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

trigger audio volume #

Trigger when an audio device's volume level changes.

Inherits from trigger

Properties

• level (integer / read and write) Comparison master volume level to compare against.
• comparison (numeric comparison / read and write) Method to compare the current volume with.

  How to compare the volume.

• audio device (audio device / read and write) Audio device to observe.
• type (trigger type / read-only) Type of trigger being described.

  This is marked as hidden and may be deprecated or not designed for public use.

condition #

Description of a testable condition that resolves to a boolean.

Properties

• type (condition type / read and write) Type of condition to test.
• invert (boolean / read and write) Invert the condition's conclusion.

  Conditions are designed to positively identify specific states. Many events will want a condition to confirm that a specific state is not occuring. To reverse the role of a positive condition, use the invert field.

  If a condition is true, and the invert field is set, the condition will invert the true and return false.

  If a condition is false, and the invert field is set, the condition will invert the false and return true.

condition boolean #

A constant condition.

Inherits from condition

Properties

• can perform (boolean / read and write) Condition immediately resolves to this value.

  If can perform is true, the condition immediately resolves to true.

  If can perform is false, the condition immediately resolves to false.

• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

condition delayed boolean #

A delayed constant condition.

Inherits from condition

Properties

• can perform (boolean / read and write) Condition immediately resolves to this value.

  If can perform is true, the condition immediately resolves to true.

  If can perform is false, the condition immediately resolves to false.

• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

condition days #

Conditional on the day of the week.

Inherits from condition

Properties

• days (list of day / read and write) The day of week is one of the following.

  days is an unordered list of week days.

  If days contains Monday and Friday, only if the current day of the week is Monday or Friday will the condition resolve to true. If the current day of the week is Tuesday, Wednesday, Thursday, Saturday, or Sunday, the condition will resolve to false.

• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

condition date range #

Conditional on the date falling within a specific period.

Inherits from condition

Properties

• not before (date / read and write) The date is not before this date.
• not after (date / read and write) The date is not after this date.
• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

condition time range #

Conditional on the time now falling within a specific period.

Inherits from condition

Properties

• not before (integer / read and write) The time is not before this time.
• not after (integer / read and write) The time is not after this time.
• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

condition execute external #

Conditional on the external executable's exit status.

Inherits from condition

Properties

• external (external / read and write) External executable to run.
• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

condition sample #

Conditional on a sample's successful conclusion.

Inherits from condition

Properties

• sample (sample / read and write) Sample to run.
• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

condition running processes #

Conditional on whether specific processes are running.

Inherits from condition

Properties

• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

condition full screen #

Conditional on whether a display has been captured for full screen use.

Inherits from condition

Properties

• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

condition power assertions #

Conditional on whether other processes have power assertions set.

Inherits from condition

Properties

• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

condition power state #

Conditional on the computer's power source state.

Inherits from condition

Properties

• state (power state / read and write) Current state of at least one power source.
• filter (power source filter / read and write) Power sources to monitor.
• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

condition battery health #

Conditional on the battery health.

Inherits from condition

Properties

• health (power health / read and write) Current health of at least one power source.
• comparison (numeric comparison / read and write) Method to compare the battery health with.

  The health values are ordered from good (high) to failure (low). The unknown state always returns false.

• filter (power source filter / read and write) Power sources to monitor.
• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

condition power remaining #

Conditional on the power remaining.

Inherits from condition

Properties

• current capacity (integer / read and write) Current percentage capacity.
• seconds remaining (integer / read and write) Estimated time remaining until fully charged or empty.

  Combine seconds remaining with a filter containing a charging value. A positive charging value indicates the power source’s seconds remaining are expected to increase. A negative charging value indicates the power source’s seconds remaining are expected to decline.

• comparison (numeric comparison / read and write) Method to compare the current capacity and seconds remaining with.

  How to compare the capacity and time remaining.

• filter (power source filter / read and write) Power sources to monitor.
• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

condition sun #

Conditional on the Sun's position being between two events.

Inherits from condition

Properties

• not before (astronomical sun event / read and write) The date is not before this Sun event.
• not after (astronomical sun event / read and write) The date is not after this Sun event.
• geolocation (geolocation / read and write) Location to calculate Sun position from.

  Calculate Sun position relative to this location on Earth.

• date (date / read and write) Date to calculate Sun position on.

  Optional date to use in Sun calculations. If omitted the current date will be used.

• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

condition user inactivity #

Conditional on the period of user inactivity.

Inherits from condition

Properties

• seconds of inactivity (integer / read and write) Period of inactivity needed.

  seconds of inactivity is measured in seconds.

• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

condition console user #

Conditional on a user being logged in.

Inherits from condition

Properties

• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

condition start up #

Conditional on time since start up.

Inherits from condition

Properties

• seconds (integer / read and write) Seconds elapsed since start up.
• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

condition audio mute #

Conditional on an audio device being muted.

Inherits from condition

Properties

• audio device (audio device / read and write) Audio device to test.
• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

condition audio volume #

Conditional on an audio device's volume level.

Inherits from condition

Properties

• level (integer / read and write) Comparison master volume level to compare against.
• comparison (numeric comparison / read and write) Method to compare the current volume with.

  How to compare the volume.

• audio device (audio device / read and write) Audio device to test.
• type (condition type / read-only) Type of condition to test.

  This is marked as hidden and may be deprecated or not designed for public use.

criteria #

Group of conditions to test.

Properties

• requires (requires / read and write) Combination of required conditions.

  The combination of conditions that must pass or fail for the criteria to be met. conditions is manipulated as an unordered set.

  An empty conditions combined with requires resolves to the following:

  • empty conditions + requires all = criteria passes;
  • empty conditions + requires at least one = criteria fails;
  • empty conditions + requires none = criteria passes.

  conditions will be sorted by expense before being tested. The engine performs the lowest number of conditions possible to determine the criteria.

  If requires is all, the first condition that fails will cause any remaining conditions to be skipped; the criteria has not been met.

  If requires is at least one, the first condition that passes will cause any remaining conditions to be skipped; the criteria has been met.

  If requires is none, the first condition that passes will cause any remaining conditions to be skipped; the criteria has not been met.

action #

Task to perform.

Properties

• type (action type / read and write) Type of action to perform.

action sleep #

Put the computer to sleep.

Inherits from action

Properties

• seconds (integer / read and write) seconds to sleep before waking up.

  Time to sleep before waking up.

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action shut down #

Shut down the computer.

Inherits from action

Properties

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action restart #

Restart the computer.

Inherits from action

Properties

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action log out #

Log out all users.

Inherits from action

Properties

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action fast user switch #

Switch to the Login Window.

Inherits from action

Properties

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action notification #

Post a notification.

Inherits from action

Properties

• scope (scope / read and write) Who can observe the notification.

  A notification can be posted within a scope. The scope determines what processes can observe it. If the scope is engine wide, only the posting instance of the engine can observe the notification. This is particularly useful for chaining triggers to performing actions.

  If the scope is host wide, every process on the host can observe the notification.

• notification (text / read and write) The notification to post.

  The notification should be formatted in reverse domain name format to avoid namespace collisions.

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action execute external #

Execute an external process.

Inherits from action

Properties

• external (external / read and write) external to execute.

  Details of the external executable to launch.

• proceed (external continues / read and write) When to continue performing any remaining actions.

  When should any remaining actions be performed.

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action launch application #

Launch an application.

Inherits from action

Properties

• application description (application description / read and write) application to launch.

  Details of the application to launch.

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action warn #

Warn users of imminent host affecting action.

Inherits from action

Properties

• seconds (integer / read and write) Seconds to display the warning.

  The warning will be active for this many seconds. While active the warning will appear in Notifications’s warning queue.

  Avoid including this value. A global default is used when this value is omitted. Administrators and users prefer consistent warning periods.

• image (text / read and write) A Universal Image Identifer.

  image is a Universal Image Identifer (UII). The image may be used in association with the warning for any user interface.

• message (text / read and write) Warning message.
• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action await once #

Wait for a specific time and date to occur.

Inherits from action

Properties

• date (date / read and write) Date and time to trigger.

  date can be any time and date in the past or future. Dates in the past are not useful but not invalid as values.

• availability (power / read and write) Should the host be made available for this trigger.

  Ensure the computer is powered on.

• scatter (integer / read and write) Scatter the date.

  Randomly distribute trigger time.

• quiet (boolean / read and write) Minimise the notifications.

  Reduce the notifications before the trigger occurs.

• drift (integer / read and write) Acceptable drift.

  Additional time for the computer to be ready.

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action await daily #

Wait for a specific time and day to occur.

Inherits from action

Properties

• seconds from midnight (integer / read and write) Seconds past midnight to trigger.

  Trigger at this time each selected day.

  The trigger’s time is measured in seconds from midnight. Where 0 seconds equals midnight.

  Calculate seconds from midnight using the following formula:

  • seconds from midnight = (hours x (60 x 60)) + (minutes x 60)
  • 5:30 am = (5 x (60 x 60)) + (30 x 60) = 19800 seconds from midnight
  • 2:23 pm = (14 x (60 x 60)) + (23 x 60) = 51780 seconds from midnight
• days (list of day / read and write) Days of the week to trigger.

  Trigger on these days of the week.

• availability (power / read and write) Should the host be made available for this trigger.

  Ensure the computer is powered on.

• scatter (integer / read and write) Scatter the date.

  Randomly distribute trigger time.

• quiet (boolean / read and write) Minimise the notifications.

  Reduce the notifications before the trigger occurs.

• drift (integer / read and write) Acceptable drift.

  Additional time for the computer to be ready.

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action await relative date #

Wait for a period of time.

Inherits from action

Properties

• seconds (integer / read and write) seconds to wait before continuing.

  Period of time to wait before continuing.

• availability (power / read and write) Should the host be made available for this trigger.

  Ensure the computer is powered on.

• scatter (integer / read and write) Scatter the date.

  Randomly distribute trigger time.

• quiet (boolean / read and write) Minimise the notifications.

  Reduce the notifications before the trigger occurs.

• drift (integer / read and write) Acceptable drift.

  Additional time for the computer to be ready.

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action await user inactivity #

Wait for a period of user inactivity.

Inherits from action

Properties

• seconds of inactivity (integer / read and write) Period of inactivity needed before triggering.

  seconds of inactivity is measured in seconds.

• trigger limit (integer / read and write) Limit the frequency of repeating triggers.

  An inactivity trigger will fire whenever the inactivity timer is greater than the required seconds of inactivity field. If the event’s conditions postpone the event’s performance, the inactivity trigger is rescheduled and would to fire again immediately. The trigger limit provides a minimum number of seconds between inactivity triggers. Each trigger limit is applied per trigger instance.

  If the inactivity trigger has a value of 15 minutes, and a trigger limit value of 5 minutes, the event will triggered once after 15 minutes of inactivity and then every 5 minutes until activity occurs.

  If the trigger’s event is removed and added, or reset, the trigger limit’s behaviour is reset.

  If activity occurs, the trigger’s trigger limit behaviour is reset. If the inactivity trigger has a value of 15 minutes, and a trigger limit value of 30 minutes, the event will triggered once after 15 minutes of inactivity and then every 30 minutes. When activity occurs, the trigger limit will reset and the trigger will next fire after 15 minutes.

  The trigger limit is optional. If a value is not provided, the seconds of inactivity field is used instead. This behaviour provides the most commonly expected outcome.

  If a value of zero seconds is set, the inactivity trigger will not repeat until the inactivity timer has been reset.

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action await notification #

Wait for a notification.

Inherits from action

Properties

• scope (scope / read and write) Observe notifications within this scope.

  Only notifications posted with the observed scope will cause the action to continue.

• notification (text / read and write) Notification to observe.

  Process wide notifications are posted as strings. Notifications should follow a reverse domain name format to avoid namespace collisions.

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action await power on #

Wait for the computer to power on.

Inherits from action

Properties

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action await start up #

Wait for the computer to start up.

Inherits from action

Properties

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action await sleep #

Wait for the computer to sleep.

Inherits from action

Properties

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action await sample #

Wait for a sample to conclude.

Inherits from action

Properties

• sample (sample / read and write) Sample to run to evaluate the environment.
• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action await log in #

Wait for a user to log in.

Inherits from action

Properties

• session type (user session type / read and write) Limit to user sessions of this type.
• session age (integer / read and write) Ignore sessions older that this duration.

  Avoid triggering for user sessions that are older this a given age.

  This cut off exists to deal with slow log in times and restarting of the Scheduler
  mid-session.
  
  The default is appropriate for most situations and the session age should be left empty.
  

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action await log out #

Wait for a user to log out.

Inherits from action

Properties

• session type (user session type / read and write) Limit to user sessions of this type.
• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action await user session time #

Wait for a user session to age.

Inherits from action

Properties

• session age (integer / read and write) Trigger when the user session reaches this age.
• session type (user session type / read and write) Limit to user sessions of this type.
• wake up (boolean / read and write) Wake up the computer from sleep when the session time is due.
• quiet (boolean / read and write) Minimise the notifications.

  Reduce the notifications before the trigger occurs.

• drift (integer / read and write) Acceptable drift.

  Additional time for the computer to be ready.

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action await battery health #

Wait for battery health to reach specific state.

Inherits from action

Properties

• now (power health / read and write) New health of the power source.
• before (power health / read and write) Previous health of the power source.
• filter (power source filter / read and write) Power sources to monitor.
• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action await power state #

Wait for the source of power to change.

Inherits from action

Properties

• now (power state / read and write) New state of the power source.
• before (power state / read and write) Previous state of the power source.
• filter (power source filter / read and write) Power sources to monitor.
• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action await power remaining #

Wait for the power remaining to change.

Inherits from action

Properties

• capacity (integer / read and write) Trigger when a power source reaches or passes this capacity.

  Capacity reaches or passes this percentage.

  A power source’s capacity may not increase and decrease in single units. The current capacity value may jump a few percentage points at a time. The trigger will fire when the current capacity equals or passes this capacity value.

  If the power source is being charged, the trigger will fire if the capacity equals or is greater than this capacity.

  If the power source is being used, the trigger will fire if the capacity equals or is less than this capacity.

  The trigger will only fire when the power source reaches or passes this capacity value.

• seconds remaining (integer / read and write) Trigger when a power source reaches or passes this duration remaining.

  Time remaining reaches or passes this duration.

• filter (power source filter / read and write) Power sources to monitor.
• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action await sun #

Wait for a specific sun observation to occur.

Inherits from action

Properties

• moment (astronomical sun event / read and write) Astronomical Sun event to calculate.
• geolocation (geolocation / read and write) Location to calculate Sun position from.

  Calculate Sun position relative to this location on Earth.

• offset (integer / read and write) Offset from the calculated astronomical event.

  Offset the calculated time.

  Useful for creating triggers to occur some time before an astronomical event.

• availability (power / read and write) Should the host be made available for this trigger.

  Ensure the computer is powered on.

• scatter (integer / read and write) Scatter the date.

  Randomly distribute trigger time.

• quiet (boolean / read and write) Minimise the notifications.

  Reduce the notifications before the trigger occurs.

• drift (integer / read and write) Acceptable drift.

  Additional time for the computer to be ready.

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action await external assistant #

Wait for a change in the external assistants.

Inherits from action

Properties

• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action await application #

Wait for an application to launch or quit.

Inherits from action

Properties

• process (process signature / read and write) Application to match.
• change (application change / read and write) Change in application to detect.
• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action audio volume #

Set the volume of an output audio device.

Inherits from action

Properties

• level (integer / read and write) Desired master volume level.
• audio device (audio device / read and write) Audio device to set.
• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

action audio mute #

Mute or unmute an output audio device.

Inherits from action

Properties

• mute (boolean / read and write) Desired mute state.
• audio device (audio device / read and write) Audio device to set.
• type (action type / read-only) Type of action to perform.

  This is marked as hidden and may be deprecated or not designed for public use.

event #

Event containing triggers to observe, conditions to test, and actions to perform.

Properties

• id (text / read and write) Unique identifier.

  A unique identifier for the event.

  We recommend the unique ID is set to a CoreFoundation UUID using its UTF8 string representation. This ensures the event’s unique ID is truely unique.

  The engine indexes events by unique ID.

• domain (text / read and write) Domain unique identifier.

  Associated domain unique identifier.

  Every event is associated with a domain. The domain is identified using a unique identifier. This is called the domain ID is present in events returned by the engine. domain is read only. Any domain passed into the engine will be ignored.

• enabled (boolean / read and write) Is the event available to be scheduled and performed.

  Setting enabled to true allows the engine to enqueue the event’s triggers.

  Setting enabled to false stops the engine from acting upon the event, even if the appropriate triggers fire.

• name (text / read and write) Presentation name.

  Name of the event.

  name need not be unique, but we recommend it is. The name should convay the purpose of the event. Try to suggest or pick names that touch upon the cause or outcome of the event.

• notes (text / read and write) Notes about this event's purpose.

  notes is provided to hold information about the event’s purpose, intent, creator, and any other miscellaneous details that may be useful to other users. No specific format should be expected.

• image (text / read and write) A Universal Image Identifer respresenting the event.

  image is a Universal Image Identifer (UII). The image will be used is association with the event throughout the user interface.

• tool (text / read and write) Owning tool in reverse domain name format.

  tool is the reverse domain named formatted identifier of the tool that created or last manipulated this event. Used to help tools identify which events they claim responsibility for. A tool with limited functionality might restrict itself to attempting to edit or show only events with a tool entry matching their own identifier.

• behaviours (list of behaviour / read and write) Non-standard event behaviour.

  Behaviours affect how the event is performed and allow the event to take on non-standard responses to situations such as requests to idle sleep, and parallel triggers.

• criteria (criteria / read and write) A criteria determining if the event performs.

  The criteria is tested after a trigger fires. Only if the criteria is met, will the actions be performed.

• access rights (list of right / read and write) Caller rights for the event.

  Access rights lists what the caller can do to this event. The rights are specific to the caller. access rights is read only. Any access rights passed into the Scheduler will be ignored.

queued trigger #

Queued trigger instance.

Properties

• id (text / read and write) Unique trigger ID of the queued trigger.

  Each queued trigger instance is provided with a unique trigger ID. This identifier should be used to track and refer to the queued trigger.

  trigger ID has not related to any other unique ID values.

• trigger (trigger / read and write) Derived trigger.

  The queued trigger may not match any trigger provided with the event. event triggers are transformed before being queued.

• event (event / read and write) event associated with trigger.

  event to perform when the trigger fires.

queued warning #

Host wide warning.

Properties

• date (date / read and write) date the action will perform.

  date will be a few seconds away. Interested clients should respond quickly the new queued warning instances.

• id (text / read and write) Unique ID for this warning.
• action (action / read and write) Action that will be performed.

  Warning clients should use action as the basis of any user facing message. message and context are provided by the event’s creator and may not be accurate.

  If action is missing, the action warning that generated this instance is the final action in the event’s actions.

• event (event / read and write) event containing this action warning.
• message (text / read and write) Warning message.

event history #

Event history.

Properties

• event ID (text / read and write) Unique identifier of the represented event.

  The event ID is included to help clients issuing multiple event history requests track responses.

• last triggered (date / read and write) Date the event was last triggered.

  The most recent date the event was triggered. If an event has multiple triggers, this date refers to the most recent trigger.

  If last triggered is not present, the event has not been triggered.

• last started (date / read and write) Date the event was last performed.

  The most recent date the event started performing. The event will perform if triggered, and then only if all the conditions are met. last started represents the date the trigger and conditions were successfully met.

  If last started is not present, the event has not been performed.

• last finished (date / read and write) Date the event last finished performing.

  The most recent date the event finished performing.

  last started may be more recent than last finished. This can happen when an event may be performed concurrently; one instance finished while a second started slightly later and is still running.

  If last finished is not present, the event has not finished being performed.

• trigger count (integer / read and write) Number of times the event has been triggered.

  An event may be triggered may times before its conditions are met. This value is incremented each time an event’s trigger is fired, regardless of whether any conditions are met.

• perform count (integer / read and write) Number of times the event has been performed.

  Count of the number of times an event has been triggered, and any conditions are met.

  The count is incremented when the event’s performance begins.

active event #

Active event instance.

Properties

• id (text / read and write) Unique ID of the active event.

  Each active event instance is provided with a unique ID. This identifier should be used to track and refer to the active event.

  active ID has no relation to any other unique ID values.

• activity (event activity / read and write) Type of activity event is undergoing.
• event (event / read and write) The event being performed or evaluated.

SSL #

A description of a SSL configuration.

Properties

• keychain (text / read and write) Absolute path to Keychain containing a certificate and a signing key.

  SSL is an absolute path to a Keychain containing a suitable certificate and signing key for the socket.

  It is best practice to create a separate Keychain.

  To use the System keychain: /Library/Keychain/System.keychain

• peer name (text / read and write) Override the name used for certificate verification.

  Provide an empty string to disable name verification.

• allow (list of SSL allowances / read and write) Lessen the requirements of the SSL certificate.
• level (SSL level / read and write) Level of SSL security to use.

socket #

A description of a TCP/IP socket.

Properties

• id (text / read and write) Unique identifier.

  unique ID must be unique within the immediate set of sockets. unique ID is used to identify a specific socket within a set and for reporting.

• interface (text / read and write) Bind to which interface (hostname).

  interface is the hostname or IP address the socket binds to. An IP address is preferred as it avoids a domain name lookup. interface format must correspond to the protocol family.

  • To bind to the localhost with IPv4 use: ‘127.0.0.1’
  • To bind to the localhost with IPv6 use: ‘::1’

  Sockets can bind to all available interfaces by setting Interface to an empty string.

• port (integer / read and write) port to accept incoming connections on.
• protocol family (protocol family / read and write) Network protocol to use.

  To listen to both IPv4 and IPv6, create two sockets with a common port but listening to different protocols.

• time out (integer / read and write) Seconds of silence before a connection times out.

  time out is the number of seconds a silent connection should wait before automatically disconnecting. A period of silence occurs when no information is being sent or received.

• service (text / read and write) PAM service.
• SSL (SSL / read and write) SSL configuration.
• Bonjour domains (list of text / read and write) Bonjour domains.

  Bonjour domains enumerates the domains in which services are published. A socket may be published in multiple domains. Where no domains are listed, the default domains are used. Where an empty list is used, Bonjour is disabled. Bonjour is also known as ZeroConf.

• options (list of socket options / read and write) Socket options.
• URLs (list of text / read and write) URL to connect to this socket.
• state (socket state / read and write) State of the socket.

URL options #

URL options.

source #

A description of a source.

Properties

• id (text / read and write) Unique identifier.

  unique ID must be unique within the immediate set of source. unique ID is used to identify a specific source within a set and for reporting.

• URL (text / read and write) URL of source.

  Absolute URL to source. URL is used to fetch the source’s configuration.

• notes (text / read and write) Notes about this source.

  notes is provided to hold information about the source. notes should be used to describe why the source is listed, who manages it, and how to contact that person in case of problems.

• options (URL options / read and write) Source URL specific options.
• state (source state / read and write) State of the source.
• fetched (date / read and write) Date of last successful fetch.

  Date and time of the last successful fetch of this source. If the source has not been successfully fetched, fetched will be excluded.

• next (date / read and write) Date of next fetch attempt.

  Earliest date and time of the next fetch attempt. The source should be enqueued for fetching at this date, but fetching can occur later. next will not be included if the source has been suspended or has encountered problems during previous attempts.

authorisation right #

An authorisation right.

Properties

• signature (text / read and write) Unique signature of the right.

  The signature maps the authorisation right to the internal request or function being authorised. Typically the signature is a combination of the lowercase object name, a period, and the lower case request name.

• rule (authorisation rule / read and write) Rule to enforce for right.

  The rule is applied when an attempt to access this right occurs.

• default rule (authorisation rule / read and write) Default rule for right.

  The rule associated with a right may be changed. Being able to identify if the right has been changed and what the original right was is useful for debugging and restoring engines to their default state.

licence #

Active licence details for the Scheduler.

Properties

• name (text / read and write) Name of the licenced contact.
• organisation (text / read and write) Organisation licenced to use the Scheduler.
• state (licence state / read and write) Licence state for the Scheduler.
• begins (date / read and write) Date the licence begins.

  Licences may start in the future and until the start date is reached, the licence is not valid. This can occur with early licence renewals.

• expires (date / read and write) Date the licence expires.

  If state is licenced or expired, expires may be omitted.

certificate #

Certificate represents an applied certificate.

Properties

• id (text / read and write) identifier uniquely identifies the certificate.

  Typically identifier will be the certificate’s serial number.

• name (text / read and write) name is the presentation name of the certificate.
• organisation (text / read and write) organisation is the presentation organisation of the certificate.
• begins (date / read and write) begins is the date before when the certificate can not be valid.
• expires (date / read and write) expires is the date when the certificate can no longer be valid.
• certificate (text / read and write) certificate is a PEM encoded X.509 certificate.

Client API #

Host device details.

Properties

• local host name (text / read-only) Computer's local host name.

  local host name is derived from the device name. The derived name is suitable for use as a URL and within the Domain Name System (DNS).

• ethernet address (text / read-only) Primary ethernet address.

  A single ethernet address. Most likely to be the MAC address from the built-in ethernet card.

  The address is formatted as six groups of two digits in lowercase.

  • xx:xx:xx:xx:xx:xx
• ethernet addresses (list of text / read-only) All ethernet addresses.

  A complete list of ethernet MAC addresses and wireless station IDs available.

  The list’s order is not specified and may change with each request.

  Each address is formatted as six groups of two digits in lowercase.

  • xx:xx:xx:xx:xx:xx
• machine model (text / read-only) Machine's model type.

  The machine model is a unique identifer per device model type.

Time Zone API #

Local time zone details

Properties

• name (text / read-only) name

  Full name of the system time zone.

• UTC offset (integer / read-only) UTC offset in seconds

  Seconds from UTC of the current system time.

Power API #

Power source details.

Authorisation API #

Authorisation control for requests and functionality.

Astronomic API #

Astronomical calculator.

Audio API #

Device audio settings.

Properties

• system master volume (integer / read and write) Master volume of the default system output device.
• system mute (boolean / read and write) Muted state of the default system output device.
• volume (integer / read and write) Master volume of the default output device.
• mute (boolean / read and write) Muted state of the default output device.

Event Store API #

Stores, organises, and tracks events.

Scheduler API #

Coordinates the events, triggers, conditions, and actions.

Properties

• enabled (boolean / read and write) Can events be triggered.

  If true, events can be triggered by their respective triggers. If false, no event will be triggered, regardless of triggers firing.

  Use enabled to effectively enable and disable the Power Manager Scheduler.

  When enabled is set to false, the Scheduler will continue to respond to requests and return information to clients. enabled only affects the triggering of events.

On Demand API #

On demand events can be performed immediately.

Notifications API #

All pending events and their notifications.

Properties

• warning period (integer / read and write) Seconds to display warnings.

  Seconds before a host affecting action that a warning should be presented.

  The warning is designed to provide the user with a reason for the shut down, sleep, or log out action that is taking place. It is not designed to replace the pending notification.

• notify period (integer / read and write) Seconds to display notifications.

  Seconds before a queued trigger that a notification should be presented.

  Changing the notify period does not affect notifications issued for currently queued triggers.

Build API #

Scheduler meta-data.

Properties

• version (text / read-only) Scheduler's release version.

  version is provided as a URI and three part release number. The Scheduler release number follows the traditional major, minor, and bug fix format.

  • The major value denotes significant changes, such as architectural modifications.
  • The minor value denotes new features or improvements.
  • The bug fix value denotes bug fixes only.

  Before presenting version, we recommend removing all but the final component of the URI. The URI is a reverse domain name styled string.

  • (product URI) v(major).(minor).(bug fix)
  • uk.co.dssw.powermanager.pmd v4.0.0
  • uk.co.dssw.powermanager.pnmd v4.0.0
• revision (text / read-only) Scheduler's revision number.

  revision is the internal version used by the developers. The higher the revision value, the more recent the version of the Scheduler. revision is used to compare Scheduler versions.

  revision should rarely be displayed in the user interface. Where version information is being presented, use the value returned by version.

  The revision value may include a mix of numbers, letters, and punctuation.

Legal API #

Legal and licensing details.

Properties

• licence (licence / read-only) Scheduler's licence details.

  licence details the state of the Scheduler and who, if anyone, holds a licence to use the Scheduler.

  Note licence does not include any private licence codes. Licence codes can not be retrieved once they are set; that is, licence codes are write only values.

Listen API #

Configures and controls incoming network connections.