Blocks & Flow EditorCommon

start

Entry point for every flow — injects the initial message and defines task variables

The start block injects a message into the flow and is the entry point of every automation task. It initializes msg properties that pass to downstream blocks. Variables defined here become task configuration fields in Bot Management Console when the task is assigned to an agent.

Bot Studio start block on canvas with palette visible

Configuration

Edit start block dialog showing message properties and cache options
FieldDescription
NameOptional display label on the canvas. If empty, the block shows as start.
PropertiesList of message properties to set when the flow starts. Click + to add a property. Each row has a property name, type, and value.
msg.payloadMain data sent into the flow. Default type is timestamp (current time in milliseconds). Can also be string, number, boolean, object, array, or a flow/global context reference.
msg.topicOptional string label categorizing the message (e.g. task category or environment tag).
msg.static_file_pathOptional path for static file references used later in the flow.
Clear Browser CacheWhen checked, clears the browser cache when the flow starts. Ensures a clean browser state for web automation.
Clear Excel CacheWhen checked, clears the Excel cache when the flow starts. Ensures no stale Excel instances from prior runs.
EnabledWhen enabled, the block is active. Disable to skip the start block without removing it.

Property types

TypeDescription
timestampCurrent date/time in milliseconds since epoch (default for payload)
stringText value
numberNumeric value
booleantrue or false
objectJSON object
arrayJSON array
flow / globalValue read from flow or global context

Outputs

PropertyTypeDescription
msg.payloadvariousThe configured payload value
msg.topicstring (optional)Topic string if configured
Custom msg.* propertiesvariousAny additional properties you add

Notes

  • Every flow must have a start block — it is created automatically with new tasks
  • Properties on the start block map to Orchestrator task variables — agents can override these per environment
  • Use custom msg property names (not payload) for values that must persist without being overwritten by downstream blocks
  • The start block runs once when the agent executes the task (not on a schedule in Studio's default setup)