Interface PlaybookConfig<I, O>

Unique identifier (required)

Accessible from: this scope only or all scopes

Whether the playbook is active. Defaults to true; preserved for round-trip data integrity.

Whether playbook can be used as nested playbook. Can only be true when executionType is 'on_demand' (enforced by PlaybookDefinitionFunction).

Reference to the playbook this was copied from. Read-only; preserved for round-trip data integrity.

Display label of the playbook this was copied from. Read-only; preserved for round-trip data integrity.

Overrides the default data retention period for playbook execution data. Omitted from generated code when the value equals the platform default ('6_week').

Optional description of playbook purpose

Platform-managed designer state. Read-only; preserved for round-trip data integrity.

Defers variant evaluation until after the specified activity completes, instead of evaluating which variant applies at playbook start (the default). Pass the $id of an activity declared in lanes — widens what a variant's condition may reference via activityRef() to include any ancestor of that activity, see docs/api/playbook-api.md for the full validation rules (must be an activity, not a lane; must not be a Run.Manually() optional activity). Omit for the default (evaluate at start) behavior.

Unlike $id, this field references another node's key within the same playbook body rather than declaring its own identity, so — unlike most $id-shaped fields — it only accepts a Now.ID['key'] reference, not a literal string/number.

Execution type

Playbook inputs - data passed into the playbook

Human-readable label shown in UI (required)

Description shown in the playbook launcher. Note: leading/trailing whitespace is trimmed during XML parsing.

Sets the value shown, in the on-demand launcher, for each of the playbook's own inputs. Requires inputs to be declared — keys are constrained to those declared input names. For a ReferenceColumn input, pass a sys_id string or a typed Record<'table'> reference. For every other input type — including BooleanColumn and IntegerColumn — pass a string, e.g. isUrgent: 'true' or retryCount: '3', not a raw true/3 literal. A raw boolean/number literal fails to compile (TypeScript rejects it), so this is the only form real playbook authors can use here. If an input has a default and no launcherInputs value is set for it, the default is shown in the launcher automatically. Setting launcherInputs only changes what's shown in the launcher — it does not change the input's own default value.

Which form view to use when creating a record via the on-demand launcher. Only applies when launcherShowRecordForm is true. The platform stores this as the view's sys_id, not its display name — 'Default view' is a special-case string that works as-is, but any other view must be passed by its actual sys_id, not its display name. Pass the sys_id as a string, or a typed Record<'sys_ui_view'> reference. The SDK cannot verify the view exists or resolve a display name to a sys_id — confirm the value in Playbook Designer before deploying. Cannot be set when executionType is 'on_demand' (enforced by PlaybookDefinitionFunction).

When true, shows the record form in the playbook launcher. Cannot be set when executionType is 'on_demand' (enforced by PlaybookDefinitionFunction).

Template fields for pre-populating record field values in the on-demand launcher. Only applies when launcherShowRecordForm is true. Use TemplateValue({ fieldName: value, ... }) or a raw 'field=value^' string. This can only be used when there is a parent table — when parentTable is set, TypeScript constrains the object keys to valid field names on that table (via the function signature's generic constraint).

Note: Record<string, unknown> is just a fallback for when parentTable isn't set — it keeps this field compiling instead of a raw TS error, so the missing-parentTable mistake is instead caught by our own, clearer diagnostics error at build time. When parentTable is set, the function signature below narrows this to the precise TemplateValueElement<P> type.

Cannot be set when executionType is 'on_demand' (enforced by PlaybookDefinitionFunction).

Title shown in the playbook launcher. Required by the on-demand launcher UI — if omitted, defaults to the playbook's label.

Optional internal name (auto-generated from label if not provided)

Now Assist knowledge base reference. Read-only; preserved for round-trip data integrity.

Now Assist prompt associated with this playbook. Read-only; preserved for round-trip data integrity.

Playbook outputs - data returned from the playbook

Table whose records this playbook operates on. Auto-generates a parent_record process input of type Reference pointing to this table. In the body, the record is accessible via params.parentRecord and is dot-walkable to all fields of the referenced table. Not allowed when executionType is 'on_demand' (enforced by PlaybookDefinitionFunction).

Playbook type name. Defaults to 'Standard playbook' when omitted. Must exist in the SDK process type mapping, for example 'Standard playbook'. Custom playbook types are not automatically supported in Fluent; each supported type requires explicit SDK mapping and diagnostics/feature handling.

Allows the playbook to be embedded on public pages and run by unauthenticated users (sys_pd_process_definition.public_access). Defaults to false.

Public playbooks are constrained on the platform, and Fluent enforces the two it can check at build time:

• parentTable is required — a public playbook must be tied to a record.
• Every activity's definition must declare publicAccess: true. Non-public definitions (for example ActivityDefinitions.Core.SendEmail) are rejected both by TypeScript, on the body entry that holds them, and by a build diagnostic naming the activity.

Requires the Process Automation Designer (sn_pa_designer) store app at version 29.0.0 or later (the Australia release) — sys_pd_process_definition.public_access doesn't exist on earlier versions; the SDK doesn't validate the installed version.

Whether playbook can be restarted

How to handle multiple runs

Schema version. Defaults to Fluent's safe fallback version (PLAYBOOK_DEFAULTS.MAX_SUPPORTED_SCHEMA_VERSION) when omitted; preserved for round-trip data integrity otherwise.

The highest schema version a given instance actually accepts depends on its release — Australia and older releases cap out at 3, Brazil and newer releases also accept 4. When deploying to a Brazil-or-newer instance, set this explicitly to 4 to opt into the newer schema. Don't infer the ceiling from the release name alone — confirm it against the target instance's com.glide.pad.core.model.maxSupportedSchemaVersion system property. See schemaVersion in playbook-api for details.

Reference to the associated sys_pd_snapshot record. Read-only; preserved for round-trip data integrity.

Lifecycle status. Defaults to 'draft'; preserved for round-trip data integrity.