Skip to main content

Workspace Settings

Workspace Settings contain all workspace metadata, connectivity information and more.

Project​

A space dedicated to storing information surrounding the Workspace.

  • Workspace Name - Define a name for the Workspace.
  • Workspace Author - Define an author for the Workspace.
  • Workspace Notes - A space to record project notes.
  • Project Location - Define the Latitude & Longitude (used for calculating sunrise & sunset times within Processes' Solar Event block).

Permissions​

The Permissions tab is used to create Users within your workspace and give them access to custom user interfaces (hosted on Ctrl Player) and Ctrl Engines' HTTP API.

  • Username & Password - Define login credentials.
  • Default Interface - The default interface that's shown when the user first logs in on Ctrl Player.
  • View Workspace - Permission to view workspaces in Ctrl Player.
  • Trigger Workspace - Interact with Interfaces to trigger Actions.

By default, Ctrl Suite auto-generates a user named Default User without a password for all new workspaces. A password can be added by pressing "Set Password". Passwords must be over six characters long.

The Permissions tab is used to create Users and Define their permissions when interacting with Ctrl Player interfaces or accessing Ctrl Suite's HTTP API.

Variables​

Variables are used within Ctrl Suite.

A variable is a named memory address that holds a value or information that can be referenced or modified by Ctrl's Processes as it runs.

Variables can take the form of a string, number, object or array, .

  • Name - *Give your variable a name i.e. my_variable (no spaces are allowed).*
  • Initial value - (Optional) Define a specific value for the variable to contain each time the workspace session is re-initialised.
  • Persist Between Sessions - Ctrl will save the latest state of the variable on every modification and recall it the next time a session is started instead of the initial value if this box is ticked. - Ideal for scoring and counter systems.
  • Disable Change Events - If this box is ticked, the variable will be frozen at its current value and be read-only. Ideal for locking out elments of your workspace whilst undertaking mantinance.

The current values of Variables can be viewed by connecting Ctrl Designer to an active Ctrl Engine incidence, then opening the Variable Viewer.

Connectivity​

The connectivity options allow outbound protocols to be defined.

Any protocol that requires physical hardware to output (i.e. a MIDI or Serial USB adaptor) requires the device to be plugged into Ctrl Engine device and adopted by Ctrl Designer for it to be configured and saved to the workspace file.

Note: the number of devices defined in the connectivity patch is directly related to the license requirements of Ctrl Engine to run the Workspace.