DocsWorkflowsComponentsMachinemachine:extension:remember

machine:extension:remember

Lands what a run worked out back on the fragment store, and writes down how the replay before it went. It is the other half of machine:extension:recall and useless without it. Recalling alone reads what the last run knew and leaves this run's repair in the outputs, where the next run cannot find it, so a page that changed is authored from nothing again on every run and the counters that would say so stay blank. A run that replayed cleanly writes no body. There is nothing new to keep, and storing the body it was just given would file a second identical revision on every run.

Options

NameTypeDescription
sitestringThe page the fragment reads, either an address or the host itself
intentstringWhat the fragment is for on that site, which with the site is the identity a later run finds it by
workflowWorkflowThe body this run ended up trusting, absent for a run that replayed what it was given and changed nothing
  ↳ idstringUniquely names the workflow. Sequences reference library fragments by it.
  ↳ namestringIs the human-readable title shown in the extension UI.
  ↳ targetTargetConfigLocates the page the workflow runs against and controls tab reuse.
    ↳ urlstringIs the address to open when no existing tab matches.
    ↳ match_urlstringIs a substring an existing tab's URL must contain for the run to reuse that tab instead of opening URL.
    ↳ reuse_tabboolReuses a matching open tab instead of opening a new one. Nil means the extension default (true).
    ↳ activateboolBrings the target tab to the foreground. Nil means the extension default (true).
    ↳ reloadboolForces a page reload on a reused tab before the first step runs.
  ↳ steps[]StepAre the actions to perform, in order.
    ↳ idstringUniquely names the step within its workflow, echoed on its StepResult.
    ↳ typestringIs the action to perform (click, fill, select, captureUrl, ...).
    ↳ labelstringIs a human-readable description shown in run progress UIs.
    ↳ selectorSelectorPicks the DOM node(s) the step acts on.
      ↳ cssstringIs a CSS selector.
      ↳ pathstringIs an explicit DOM path, used when CSS cannot express the target.
      ↳ indexes[]intNarrows a multi-match selector to these positions.
      ↳ enter[]stringNames the subtrees CSS has to resolve inside, outermost first. Each entry selects a shadow host or an iframe, resolved in the tree the previous entry opened, so a control inside a web component inside a same-origin frame is reachable by one Selector. Empty runs CSS against the top document.
      ↳ indexintNarrows a multi-match selector to a single position.
      ↳ allboolExpands the step to act on every match instead of the first.
    ↳ valuestringIs the input for value-taking steps such as fill and select. It may contain {{ variable }} placeholders.
    ↳ formatstringNames the shape extraction steps return their data in.
    ↳ attributestringNames the DOM attribute an extraction step reads.
    ↳ fieldsExtractFieldAre the named columns an extractList step reads out of each item its selector matched. Key order is the column order, and every returned item carries every key.
    ↳ limitintCaps how many items an extractList step returns. The extension applies its own bound when this is zero, so a listing that lazily grew to ten thousand rows truncates and says so.
    ↳ urlstringIs the address for navigation steps.
    ↳ fnstringNames the page function an eval step invokes.
    ↳ args[]anyAre the arguments passed to Fn.
    ↳ body_paramsmap[string]stringOverrides or adds form fields on the request a captureDownload re-issues, and carries the parameters a captureUrl sends, in the query for a GET and form-encoded otherwise.
    ↳ methodstringIs the HTTP method a captureUrl step fetches its URL with, defaulting to GET.
    ↳ filenamestringRenames a captured file (captureDownload, captureUrl and capturePageFile). It may contain {{ variable }} placeholders.
    ↳ outputstringChooses where a captured file goes, and the controlling client is its only destination.
    ↳ waitWaitConfigBlocks the step until a page condition holds.
      ↳ selectorstringWaits for a matching element to appear (or disappear, see Absent).
      ↳ textstringWaits for this text to be present on the page.
      ↳ url_includesstringWaits for the page URL to contain this substring.
      ↳ absentboolFlips the wait to expect the selector to disappear rather than appear.
      ↳ delay_msintIs a fixed pause in milliseconds, applied on top of any condition.
      ↳ timeout_msintBounds the wait, in milliseconds.
    ↳ promptstringIs the text shown at a user gate asking for manual input.
    ↳ continue_onContinueConditionHolds the step until a user gate is cleared or a page condition is met.
      ↳ manualboolPauses the run for an explicit user continue.
      ↳ selectorstringResumes when a matching element appears.
      ↳ textstringResumes when this text is present on the page.
      ↳ url_includesstringResumes when the page URL contains this substring.
      ↳ timeout_msintBounds the hold, in milliseconds.
    ↳ timeout_msintOverrides the workflow's default step timeout, in milliseconds.
    ↳ optionalboolLets the run continue when this step fails.
    ↳ conditionConditionCondition, when set, gates the step. If it does not hold, the step is skipped rather than failed.
      ↳ selectorstringHolds when a matching element exists on the page.
      ↳ textstringHolds when the page (or the selected element) contains this text.
      ↳ url_includesstringHolds when the page URL contains this substring.
      ↳ matchstringDecides how the set predicates combine, "any" or "all".
      ↳ negateboolInverts the combined result.
    ↳ storestringNames a slot the step's data is saved under, readable by later steps and returned on the WorkflowResult.
    ↳ resumeResumePointResume, when set, marks this step as a point a re-run may start at, and carries the predicate recognizing a browser already standing there.
      ↳ idstringNames this point so a later point's Rewind can reach it. It is unique within one workflow.
      ↳ whenConditionRecognizes the browser standing at this point.
        ↳ selectorstringHolds when a matching element exists on the page.
        ↳ textstringHolds when the page (or the selected element) contains this text.
        ↳ url_includesstringHolds when the page URL contains this substring.
        ↳ matchstringDecides how the set predicates combine, "any" or "all".
        ↳ negateboolInverts the combined result.
      ↳ rewindRewindRewind, when set, is how the browser leaves this point for an earlier one.
        ↳ tostringNames the resume point this reaches, which must sit earlier in the step list than the point declaring it.
        ↳ urlstringNavigates the tab back to the earlier point.
        ↳ selectorstringClicks a control on the current page that leads back, for a flow whose way back is a button rather than an address.
        ↳ waitWaitConfigHolds until the page has settled after the rewind, before the target point's own predicate is checked again.
          ↳ selectorstringWaits for a matching element to appear (or disappear, see Absent).
          ↳ textstringWaits for this text to be present on the page.
          ↳ url_includesstringWaits for the page URL to contain this substring.
          ↳ absentboolFlips the wait to expect the selector to disappear rather than appear.
          ↳ delay_msintIs a fixed pause in milliseconds, applied on top of any condition.
          ↳ timeout_msintBounds the wait, in milliseconds.
    ↳ alwaysboolRuns the step even when re-entry starts the run past it, for work the page cannot report as already done.
  ↳ optionsWorkflowOptionsCarries run-wide defaults such as the step timeout and the tab contention policy.
    ↳ default_timeout_msintIs the per-step timeout in milliseconds for steps that do not set their own.
    ↳ continue_on_errorboolKeeps the run going past a failed step instead of stopping at the first failure.
    ↳ concurrencystringIs the contention policy when another run already holds the target tab, one of "queue" (default), "parallel", or "reject".
    ↳ reentryboolLets a run start at a resume point the live page matches instead of replaying from the first step. Nil means the extension default (true), and an explicit false forces a clean run of a fragment that declares points.
  ↳ conditionConditionCondition, when set, gates the whole workflow. If it does not hold, the run is skipped rather than failed.
    ↳ selectorstringHolds when a matching element exists on the page.
    ↳ textstringHolds when the page (or the selected element) contains this text.
    ↳ url_includesstringHolds when the page URL contains this substring.
    ↳ matchstringDecides how the set predicates combine, "any" or "all".
    ↳ negateboolInverts the combined result.
contractExtContractWhat that body promises a replay will return
  ↳ storestringNames the slot the rows land in, which is the store of the fragment's own extractList step.
  ↳ fields[]stringAre the columns every healthy row carries. A column no row answers is a selector that stopped matching, whatever the run reported.
  ↳ min_rowsintIs the fewest rows a healthy run returns, one by default. A listing that answers with nothing is the case this is here for.
  ↳ fileboolSays the fragment's read is a captured file rather than a listing, so a healthy run is one that came back with bytes under a name. It is the same silence in a different shape, since a capture whose form moved answers with nothing and reports success.
namestringThe title the fragment is stored under, defaulting to its intent
goalstringWhat the fragment is for, in the words an authoring session was given
start_urlstringThe page the fragment opens on
reasonstringWhy this body was authored, which is the break it repairs
fragment_idstringThe fragment a replay outcome is recorded against, which is what was recalled
statusstringHow the replay went, ok for one that honored its contract and failed for one that did not
run_idstringThe run that produced the body, which is how it is traced back to what it read

Outputs

NameTypeDescription
storedboolWhether a body was written
fragment_idstringThe head the body now belongs to
revision_idstringThe body that was written
recordedboolWhether the replay outcome was written down against the fragment
sitestringThe host the fragment is held under