Recording
The session.recording node turns session recording on for sessions running under a policy, optionally captures audio, and can override the global retention period.
session.recordingProperties
| Property | Type | Default | Min / max | Notes |
|---|---|---|---|---|
enabled | boolean | false | — | Record sessions using this policy. |
includeAudio | boolean | false | — | Capture audio in the recording. |
retentionDays | integer | — | 1 – 365 | days. Overrides the global retention period for recordings under this policy. |
Sample
"recording": {
"enabled": true,
"includeAudio": false,
"retentionDays": 90
}
Precedence
Recording can be decided at several levels. The effective setting is resolved in this order, most specific first:
- User — a per-account override in the database.
- Workspace policy — this
session.recordingnode. - Organization — a tenant-wide database setting.
- Global — the app.config.xml
<sessionRecording>default.
Playback and management
Recorded sessions are listed in the Recordings section, where they can be played back and downloaded for compliance, training or incident investigation. For the broader picture, see Session Recording.
When IAM has no user, workspace, or org recording override, the Gateway injects the app.config.xml global default (<sessionRecording><enabled> and the audio format) into the policy's session.recording before the backend sees it — so recording works even without database entries. Storage caps are separately bounded by the license: the effective maximum is the smaller of the configured maxStorageGB and the license limit.
Recording captures user activity and may be subject to privacy and employment regulations. Confirm your notification and retention obligations before enabling it broadly.