ModelHooks module

Batch

Batch Entity

A model in the Hooks module, with 17 members for templates, 15 API properties and 18 members for admin templates.

Hooks\Models\Frontend\Batch Hooks\Models\Api\Batch Hooks\Models\Backend\Batch Also in Hooks: AgentAction BatchAction Category Condition ConditionElse ConditionIf CreateFileAction CreateRecordAction DeleteRecordAction EntityBatchEvent EntityEvent Hook HttpRequestAction HttpResponseAction Loop LoopElement MergeFilesAction MergeToPDFAction RenderTemplateAction RetrieveRecordsAction ScheduledBatchEvent SendMailAction SourceHookBatchEvent StopAction TriggerHookAction UpdateRecordAction WebBatchEvent WebEvent

Templates view

Properties 17

Take no arguments.

# getAgentActionId(): ?int; Id of the agent action this batch runs, or null when its hook has none. Drives the re-run affordance: only batches that run an agent have a recorded invocation worth replaying, so only they are offered the replay/fresh choice. Serialised into the admin batch listing as a nullable id rather than a boolean because the webix conversion rewrites booleans to a translated "Yes"/"No".
# hasAgentAction(): bool; Whether this batch runs an AI agent
# isInterrupted(): bool; Check whether the batch execution should be interrupted
# getFolderPath(): string; Get the folder to use when working with files (in the files module) for this batch
# isStopped(): bool; Check whether the execution has been stopped
# getId(): ?int
# getStatus(): ?string
# getCustomData(): array
# getBatchEvent(): ?BatchEvent
# getCreated(): ?DateTime
# getModified(): ?DateTime
# getSite(): ?Site
# getHook(): ?Hook
# getBatchActions(): ?Collection<atchAction>
# isNewRecord() Not in API & Jobs: bool; Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs: bool; Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs: bool; Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 15

Read-only values on the record.

# agentActionId: ?int; Id of the agent action this batch runs, or null when its hook has none. Drives the re-run affordance: only batches that run an agent have a recorded invocation worth replaying, so only they are offered the replay/fresh choice. Serialised into the admin batch listing as a nullable id rather than a boolean because the webix conversion rewrites booleans to a translated "Yes"/"No".
# agentAction: bool; Whether this batch runs an AI agent
# interrupted: bool; Check whether the batch execution should be interrupted
# folderPath: string; Get the folder to use when working with files (in the files module) for this batch
# stopped: bool; Check whether the execution has been stopped
# hateoasLinks Not in Templates: array; Get the HATEOAS links for the record
# id: ?int
# status: ?string
# customData: array
# batchEvent: ?BatchEvent
# created: ?DateTime
# modified: ?DateTime
# site: ?Site
# hook: ?Hook
# batchActions: ?Collection<atchAction>

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 18