grandMA3 User Manual
- About the manual
- Device Overview
  - grandMA3 consoles
    - grandMA3 full-size
    - grandMA3 full-size CRV
    - grandMA3 light
    - grandMA3 light CRV
    - grandMA3 compact XT
    - grandMA3 compact
  - grandMA3 extension
  - grandMA3 replay unit
  - grandMA3 processing units
  - grandMA3 Nodes
  - grandMA3 Nodes DIN-Rail
  - grandMA3 I/O Node
  - grandMA3 I/O Node DIN-Rail
  - grandMA3 onPC command wing XT
  - grandMA3 onPC command wing
  - grandMA3 onPC fader wing
  - grandMA3 onPC rack-unit
  - Screen allocation
  - Keyboard shortcuts
  - Keys
    - . [Dot]
    - <<< [GoFastBackward] | Black
    - >>> [GoFastForward] | Flash
    - - [Minus]
    - + [Plus]
    - / [Slash] | * [Asterisk/Multiply]
    - At
    - Assign
    - Align
    - Blind
    - Clear
    - Channel
    - Copy
    - Ctrl
    - Cue
    - Down
    - Delete
    - Esc
    - Edit
    - Freeze
    - Full
    - Fixture
    - Group
    - Goto
    - Go+ [large]
    - Go- [large]
    - Go+ | Temp
    - Go- | Top
    - Help
    - Highlt [Highlight]
    - If
    - Learn | Rate1
    - List
    - MA
    - Menu
    - Move
    - Next
    - Numeric keys | arrows
    - Oops
    - On
    - Off
    - Pause [large]
    - Pause | Fix
    - Page+
    - Page-
    - Please
    - Power
    - Preset
    - Prvw [Preview]
    - Prev [Previous]
    - Select
    - SelFix [SelectFixture]
    - Sequ [Sequence]
    - Set
    - Solo
    - Stomp
    - Store
    - Thru
    - Time
    - Up
    - Update
    - U1
    - U2
    - X1 | Clone
    - X2 | Link
    - X3 | Grid
    - X4 | Layout
    - X5 | Step
    - X6 | TC
    - X7 | View
    - X8 | DMX
    - X9
    - X10
    - X11
    - X12
    - X13 | Phaser
    - X14 | Macro
    - X15 | Page
    - X16 | Exec
    - Xkeys
  - Control elements
    - Command area
    - Master area
    - Custom area
    - Dual encoders
    - Level wheel
    - Grand master
    - Executor elements
  - Connector pin assignment
  - UPS battery
- System Overview
  - Standalone device
  - Locally networked devices
  - World server
  - Parameters
    - Calculate parameters
    - Expand the amount of parameters
- First Steps
  - Unpack the device
  - Check scope of delivery
  - Position the device
  - Connect power
  - Connect desk light
  - Connect external screens
  - Connect USB devices
  - Connect DMX
  - Connect Audio In
  - Connect MIDI
  - Connect LTC
  - Connect Ethernet
  - Connect DC Remote In
  - Connect grandMA3 extension
  - Connect grandMA3 fader wing
  - Turn on the device the first time
- grandMA3 onPC
  - System requirements grandMA3 onPC
  - Windows installation
  - Optimize Windows
  - macOS installation
  - Optimize macOS
  - onPC Terminal App
  - onPC settings
- Show File Handling
- Workspace
  - User interface
    - Configuration of displays
    - Desk lock
    - User-defined area
    - Command line
    - Control bar
    - View bar
    - Tables in general
    - Trackpad window
  - Gestures
  - Command area
  - Master controls
  - Playback controls
  - Displays in grandMA3 onPC
  - Encoder bar
    - Feature group control bar
    - Encoder toolbar
  - Calculator
  - Playback bar
  - Command wing bar
  - Colors
    - System
    - Markers
    - Color theme
- Command Syntax and Keywords
  - General syntax rules
  - General keywords
    - ; [Semicolon]
    - / [Slash]
    - . [Dot]
    - .. [DotDot]
    - = [Equal]
    - <<< [GoFastBackward]
    - >>> [GoFastForward]
    - - [Minus]
    - * [Asterisk]
    - % [Percent]
    - + [Plus]
    - Absolute
    - Acceleration
    - Action
    - ActivationGroup
    - Agenda
    - Align
    - AlignTransition
    - Appearance
    - Assign
    - At
    - Attribute
    - AutoCreate
    - Black
    - Blind
    - Block
    - BPM
    - Call
    - Camera
    - Capture
    - ChangeDestination
    - Channel
    - ChannelSet
    - Chat
    - ChatJoin
    - ChatLeave
    - Cleanup
    - Clear
    - ClearActive
    - ClearAll
    - ClearSelection
    - Clone
    - CommandDelay
    - Collect
    - Collection
    - Color
    - ColorDef
    - ColorTheme
    - Configuration
    - Console
    - Cook
    - Copy
    - Cue
    - CueAbs
    - CueDelay
    - CueFade
    - CueInDelay
    - CueInFade
    - CueOutDelay
    - CueOutFade
    - CueRel
    - CueUpdate
    - CurrentEnvironment
    - CurrentUser
    - CurrentUserProfile
    - Cut
    - DataPool
    - Deceleration
    - Decimal8
    - Decimal16
    - Decimal24
    - Default
    - Delay
    - Delete
    - DeleteOtherVersions
    - DelGlobalVar
    - DelUserVar
    - Dismiss
    - Display
    - DMXLayer
    - DMXAddress
    - DMXReadout
    - DMXUniverse
    - DoubleSpeed
    - Down
    - DumpLog
    - Drive
    - Echo
    - Edit
    - EditSetting
    - Eject
    - Effect
    - EndIf
    - Environment
    - Exchange
    - Executor
    - Export
    - Extract
    - Extension
    - Fade
    - Fader
    - FaderMaster
    - FaderRate
    - FaderSpeed
    - FaderTemp
    - FaderTime
    - FaderX
    - FaderXA
    - FaderXB
    - FeatureGroup
    - Filter
    - Fix
    - FixtureClass
    - FixtureLayer
    - Fixture
    - FixtureType
    - Flip
    - Flash
    - Fog
    - Font
    - Freeze
    - Full
    - Gel
    - GetGlobalVar
    - GetUserVar
    - Go+
    - Go-
    - Goto
    - Grid
    - GridPos
    - Group
    - HalfSpeed
    - HardwareKey
    - Help
    - Helplua
    - Hex8
    - Hex16
    - Hex24
    - Highlight
    - Houselights
    - Hz
    - If
    - IfActive
    - IfOutput
    - IfProg
    - Image
    - Import
    - Index
    - Insert
    - Integrate
    - Interface
    - Invert
    - Invite
    - IP
    - JoinSession
    - Key
    - Keyboard
    - KeyboardShortcuts
    - Knockin
    - Knockout
    - Label
    - Language
    - Layout
    - LearnSpeed
    - LeaveSession
    - Library
    - List
    - ListOwner
    - ListRef
    - Load
    - Loaded
    - LoadShow
    - Lock
    - Login
    - Logout
    - Lowlight
    - Lua
    - LuaFile
    - Macro
    - MArker
    - Master
    - MAtricks
    - Measure
    - Media
    - MemInfo
    - Menu
    - Mesh
    - MessageCenter
    - Monitor
    - Move
    - Multipatch
    - MyRunningMacro
    - MyRunningPreset
    - MyRunningSequence
    - Natural
    - NDI
    - NewShow
    - NextY
    - NextZ
    - Next
    - Node
    - NonDim
    - Normal
    - Off
    - Offset
    - On
    - onPC
    - OSC
    - Oops
    - OutputLayer
    - Page
    - Part
    - Park
    - Paste
    - Patch
    - Pause
    - Percent
    - PercentFine
    - Phase
    - Physical
    - Plugin
    - Preset
    - PresetUpdate
    - Press
    - Preview
    - PreviousY
    - PreviousZ
    - Previous
    - Programmer
    - Property
    - PU
    - Pyro
    - Rate1
    - RDM
    - Readout
    - Reboot
    - Recast
    - Record
    - Relation
    - Relative
    - Release
    - ReloadPlugins
    - ReloadUI
    - Remote
    - RemoteHID
    - RemoteCommand
    - Remove
    - RenderQuality
    - Reset
    - Restart
    - Root
    - RTChannel
    - RunningMacro
    - RunningPreset
    - RunningSequence
    - RunningTimecode
    - SaveShow
    - ScreenConfig
    - ScreenContent
    - Scribble
    - Seconds
    - Select
    - Selection
    - SelFix
    - Sequence
    - SendMIDI
    - SendOSC
    - Set
    - SetGlobalVar
    - SetUserVar
    - Shuffle
    - Shutdown
    - SnapDelay
    - SoftwareImport
    - SoftwareUpdate
    - SoundChannel
    - Solo
    - SpecialExecutor
    - Speed
    - Speed1
    - Stage
    - Station
    - Step
    - Stomp
    - SwitchGma2Mode
    - Swop
    - Store
    - Temp
    - Texture
    - Thru
    - Time
    - Timecode
    - TimecodeSlot
    - Toggle
    - TopUp
    - Top
    - Transition
    - Type
    - UIChannel
    - UIGridSelection
    - UnBlock
    - Universal
    - UnLock
    - UnPark
    - UnPress
    - Up
    - Update
    - UpdateContent
    - User1
    - User2
    - User
    - UserProfile
    - Video
    - Version
    - View
    - ViewButton
    - Width
    - World
    - Xkeys
    - Zero
  - Option keywords
    - /Active
    - /ActiveForSelected
    - /AddNewContent
    - /All
    - /AllForSelected
    - /Ask
    - /Auto
    - /CopyCueDst
    - /CopyCueScr
    - /CreateReferenceObject
    - /CreateSecondCue
    - /CueOnly
    - /Date
    - /Default
    - /DiscardChanges
    - /DMX
    - /Embed
    - /Enumerate
    - /File
    - /ForceGlobal
    - /GDTF
    - /Gaps
    - /Global
    - /GridMergeMode
    - /Indirect
    - /KeepActivation
    - /Look
    - /Merge
    - /NoConfirm
    - /OriginalContentOnly
    - /Overwrite
    - /Path
    - /Release
    - /Remove
    - /Screen
    - /Selective
    - /Universal
  - Extended command line syntax options
- Windows, Views, and Menus
  - Add window
  - Rearrange
  - Store and recall views
  - Remove windows from a screen
  - Window settings
  - Menus
  - Change menu locations
  - Pool windows
    - Create pool object
    - Label pool objects
    - Move pool objects
    - Insert pool objects
    - Copy pool objects
    - Lock and unlock pool objects
    - Delete pool objects
- Networking
  - Interfaces and IP
  - Session
    - Create a session
    - Join a session
    - Leave a session
    - Invite to a session
    - Dismiss from session
    - Create a custom key
    - Session master selection
  - Web remote
- DMX In and Out
  - DMX port configuration
  - Ethernet DMX
    - Art-Net menu
    - sACN menu
    - Transmit DMX using Art-Net
- Single User and Multi User Systems
  - Create User
  - User settings
- Patch and Fixture Setup
  - What are fixtures
  - Add fixtures to the show
  - Add multipatch fixtures
  - MVR
  - Live patch
  - DMX sheet
  - DMX universes
  - Remove fixtures from the show
  - Position fixtures in the 3D space
  - 3D
  - Camera Pool
  - Stages
  - Classes and Layers
  - Attribute definitions
    - Activation group
    - Feature group
    - Deactivation group
  - Parameter list
  - DMX curves
- Operate Fixtures
  - Select Fixtures
  - What is the programmer
  - Fixture sheet
  - Encoder resolution
  - Using the color picker
  - Gel pool
  - Selection bar
  - Align
  - Selection Grid
  - Smart view
  - General parent.child structure
- Scribbles
  - Create scribbles
  - Edit scribbles
  - Assign scribbles
  - Delete scribbles
- Images
  - Screenshots
- Video
- Appearances
  - Create appearances
  - Use appearances
  - Delete appearances
- Groups
  - Create groups
  - Edit groups
  - Delete groups
  - Group masters
- Presets
  - Preset pools
  - Create new presets
  - Recipe presets
  - Use preset
  - Edit or Update presets
- Worlds and Filters
  - At filter
  - Create a world
  - Create a filter
  - Use a world or filter
  - Delete a world
  - Delete a filter
- MAtricks and Shuffle
  - Blocks
  - Groups
  - Wings
  - Widths
  - Shuffle
  - Transform
- Cues and Sequences
  - What is tracking
  - Sequences sheet
  - Content sheet
  - Sequence settings
  - Store cues
  - Update cues
  - Copy cues
  - Cue recipes
  - Store settings and preferences
  - Play back cues
  - Move in black
  - Cue timing
  - Renumber cues
  - Delete cues
- Executors
  - Assign object to an executor
  - Executor configurations
  - Running playbacks
  - Special executors
- Masters
  - Selected masters
  - Grand masters
    - Time Control
  - Speed masters
  - Playback masters
- Recipes
- Phasers
  - Phaser editor
  - Create sinus dimmer phaser
  - Create circle phaser
  - Create circle phaser around position
  - Create color rainbow phaser
- XYZ
  - Activating XYZ for fixture types
  - MArker fixture
- Macros
  - Create macros
  - Edit macros
  - Assign macros to keys and buttons
  - Variables
  - Examples
- Agenda
  - View modes
  - Create an agenda entry
  - Edit an agenda entry
  - Agenda toolbar
- Timecode
  - What are timecode slots
  - Timecode settings
  - Track groups
  - Time ranges and events
  - Toggle view mode
  - Record a timecode show
  - Record an external timecode show
  - Edit a timecode show
- Layouts
  - Create a layout
  - Assign multipatch fixtures
  - Edit layout
  - Layout view settings
  - Edit layout view
  - Edit layout elements
  - Layout encoder bar
- Plugins
  - What is Lua?
  - Handle
  - Functions - Object-Free API
    - BuildDetails
    - CloseUndo
    - Cmd
    - CmdIndirect
    - CmdIndirectWait
    - CmdObj
    - Confirm
    - CreateUndo
    - DataPool
    - DefaultDisplayPositions
    - DeskLocked
    - Echo
    - ErrEcho
    - ErrPrintf
    - Export
    - ExportCSV
    - ExportJson
    - FromAddr
    - GetPath
    - GetShowFileStatus
    - GetSubfixture
    - GetSubfixtureCount
    - HandleToStr
    - HandleToInt
    - HookObjectChange
    - HostOS
    - HostSubType
    - HostType
    - Import
    - IntToHandle
    - MasterPool
    - MessageBox
    - ObjectList
    - Patch
    - PopupInput
    - Printf
    - ProgrammerPart
    - ProgressBar
    - Pult
    - Root
    - SelectedSequence
    - Selection
    - SelectionCount
    - SelectionFirst
    - SelectionNext
    - SerialNumber
    - ShowData
    - StrToHandle
    - ShowSettings
    - TextInput
    - Timer
    - UserVariables
    - Version
  - Functions - Object API
    - Addr
    - AddrNative
    - Children
    - Dump
    - Export
    - HasActivePlayback
    - Import
    - ToAddr
- Data Pools
- System
  - Date and time
  - Clock
  - Desk lights
  - System information
  - System monitor
  - Info Window
- Sound
  - Sound Window
- Remote In and Out
  - DC remotes
  - MIDI remotes
  - DMX remotes
  - OSC
  - PSN
  - MIDI
- RDM
- Control other MA Devices
  - grandMA3 Nodes
  - MA Network Switch
  - RemoteHID
- Update the Software
  - Update grandMA3 consoles
  - Update grandMA3 Nodes
  - Update grandMA3 onPC windows hardware
  - Update grandMA3 viz-key
  - Network update
  - Delete update files
  - Troubleshooting
- Fixture Types
  - Import fixture types
    - Import GDTF
    - Conflicts in fixture types
  - Build fixture types
    - Insert fixture types
    - Insert DMXModes
    - Insert geometries
    - Insert models
    - Link models to geometries
    - Link DMX modes to geometries
  - Export fixture types
    - Export GDTF
- File Management
  - SFTP connection
  - Import / Export Menu
  - Folder Structure
- Shut down the System
- Troubleshooting
  - Clean start
grandMA3 Quick Start Guide
grandMA3 Quick Manual consoles
grandMA3 Quick Manual processing units
grandMA3 Quick Manual Nodes
grandMA3 Quick Manual Nodes DIN-Rail
grandMA3 Quick Manual onPC command wing XT
grandMA3 Quick Manual onPC command wing
grandMA3 Quick Manual onPC fader wing
grandMA3 Quick Manual onPC rack-unit
grandMA3 Quick Manual viz-key
grandMA3 Quick Manual I/O Nodes
Release Notes

Hint:
New help version
The help version you selected belongs to an older software version. You may want to view the latest help version.

Version 1.8

Join a Session

Table of contents of this topic

hide

Join a Session Using the User Interface
Join a Session Using the Command Line

Important:
Merge All Data is temporarily not available in the bug fix 1.8.8.2.
This feature is under revision. We recommend not to use it in earlier versions.

Requirement:

Network connections need to be made and the correct IP address should be set - For more information see Interfaces and IP. There needs to be a running session that can be joined.

When a console or onPC station wants to join a session or gets invited into a session, the session recognizes that the station joining already was a part of the session at a previous point in time.

If this is not the case then the station joins the session and gets the show file.

If the same show file is loaded on both sides, the grandMA3 software can merge both show files. This is useful in undetected scenarios such as a station being disconnected for a time from the rest of the session (maybe because of a defect in the network cable or other causes of failure). If on both sides (the remaining session and the disconnected station) users worked further on the show file, users have to decide to choose between one of the two show files. Meaning they had to reprogram the changes of the lost show file in the one that is kept. The Merge All Data option combines the data of both show files in one show file.

This is the small pop-up asking what to do:

The Session Data Merge pop-up is visible for 60 seconds. After 60 seconds without a response, the session data merge will be canceled.

To pause the countdown, tap in the text area of the pop-up. When such a station as described above now joins the session again, a pop-up informs the user about a Session Data Merge.

There are 3 options to choose from:

Merge All Data:
Merges the changes of all connecting stations into one show file.
Keep only Master Data:
The changes in the show file data of the connecting devices are ignored. The show file of the Master side is maintained. Before overriding the show file of the connecting devices, the show file will be saved automatically on the connecting stations.
Cancel:
The connecting stations will not join the session of the Master side and be made Standalone. Then it can be investigated which show file is the correct one, then back up each show file, etc.

Merging the data of two show files is supported for these object types, at the moment:

Sequences with Cue and Cue Part
Presets
Recipes
Programmer and Programmer Parts
Timecodes
Macros, Plugins, and PluginComponents
Pages and Executors
Images and Videos
DataPools
Groups
All other pools not explicitly mentioned here

Known Limitations:
- Changes made to the patch during the disconnection of a station disables the possibility to merge.
- Merging the deletion of parts of objects during the disconnection of a station is not fully working, yet. (for example, deleting one macro line or deleting a recipe line)
- Merging the movement of objects during the disconnection of a station creates duplicates: At the original spot and the new spot. This may result, for example, in having different sequences assigned to the same executor on different stations.

Join a Session Using the User Interface

Open the Network menu.
Tap the buttons at the bottom that needs to be edited:
- Make sure that the correct interface is selected.
- Make sure the correct Key is selected.
Tap the station with the desired running session.
Tap Join Session.
- The network icon and the stations should become green.
If the Session Data Collision pop-up appears, then select the desired option.

Join a Session Using the Command Line

Use the JoinSession keyword to join existing or create a new session.

Restriction:
It is only possible to join a session if the joining station got the same key as the currently active key on the selected station (step 3 above) currently in the session.
This means that the station that wants to join a session selects a station already in the session. The station already in the session got a selected key. The joining station needs to have the same key selected to be able to join the session.