OpenKatana · Audit reference plan:
OpenKatana_audit_reference_plan checks whether a project's saved editing timeline follows its recorded reference plan. It helps you catch differences in exact cut frames, literal text and its timing, font file hashes, and specified shot settings before proceeding with an edit. The audit compares the saved editing instructions with an explicitly recorded specification rather than automatically interpreting the reference image or video. It also checks reference source integrity: the supplied tests confirm that changing the reference file after recording a plan causes the audit to fail. This makes the node useful as a quality-control checkpoint when recreating a reference or preserving approved editing requirements. A passing audit means the timeline agrees with the recorded requirements, not that those requirements accurately describe the reference or that the rendered result is visually identical. You should verify the plan visually before relying on it.
OpenKatana · Audit reference plan Input Parameters:
project_id
A required STRING identifying the OpenKatana project whose saved timeline you want to audit. The underlying operation uses this identifier to locate the project and read its current saved timeline, so you should select the same project in which you recorded the reference plan and saved your edit. Choosing a different project checks that project's state instead; the node does not audit an arbitrary timeline supplied directly through this interface. A saved timeline is required, and the comparison depends on a previously recorded reference plan. The provided interface does not specify a default value, a list of allowed identifiers, length limits, or minimum and maximum values.
arguments
A required STRING passed through the tool wrapper's argument-processing step before the audit operation is invoked. The underlying audit operation accepts only a project identifier, so it has no audit-specific controls for tolerance, frame ranges, or comparison modes. Use this field according to the OpenKatana wrapper's argument format; an empty JSON object, written as {}, expresses that you are supplying no additional arguments, although the supplied code does not expose the parser implementation or explicitly confirm its accepted syntax. Do not put a reference plan or an unsaved timeline here in an attempt to replace the project's recorded data. No default, length limits, minimum, maximum, or predefined options are shown in the provided interface.
after
An optional STRING accepted by the node's execution method, with a method-level default of None when omitted. In the supplied implementation, this value is not read or forwarded to the audit operation, so its contents do not select a reference plan, alter comparison strictness, or change the audit results. A connection to this input can provide a workflow dependency, but the shown code does not interpret the incoming string as an instruction or validate it as evidence that an earlier operation succeeded. No text default, length limits, minimum, maximum, or predefined options are specified in the provided interface.
OpenKatana · Audit reference plan Output Parameters:
result_json
A STRING containing the tool response serialized as JSON. The underlying audit returns matches_plan, a Boolean indicating whether any issues were found; issues, the collection of detected problems; reference_sha256, the reference file hash recorded with the plan; and note, an explanation of the audit's limitations. A value of true for matches_plan means no issues were detected against the recorded plan, while false means you should inspect issues and resolve the differences. The reference hash is a content fingerprint, not a visual similarity score. The returned note states: “Checks the recorded plan, not whether its transcription, timings or effects accurately describe the reference. Validate the plan visually first.” The wrapper's response-formatting implementation is not supplied, so these fields describe the underlying audit data without assuming whether it appears at the top level or inside an additional response envelope. This output is a report, not a corrected timeline or a rendered preview.
OpenKatana · Audit reference plan Usage Tips:
- Record and visually verify the reference plan before auditing. Confirm that the intended cut positions, text, timings, fonts, and shot requirements are correct; the audit cannot determine whether an incorrectly transcribed plan faithfully represents your reference.
- Save your timeline before running the node. The operation reads the project's saved timeline, so changes that have not been saved will not be the edit being checked.
- Keep
project_idconsistent across the plan-recording, timeline-saving, and audit steps. This prevents accidentally auditing a different project or checking an older edit. - Treat timing requirements as exact requirements rather than approximate visual targets. In the supplied test, text appearing at 0 seconds for 0.5 seconds matches a 30 fps requirement covering frames 0–15, but moving its start to 0.1 seconds makes the audit fail.
- Include requirements explicitly when recording the plan. Shot checking compares the specified fields with the corresponding shot by index; do not assume an unspecified visual property is automatically checked.
- Keep the reference file unchanged after recording the plan. If you intentionally replace it, review and record the updated plan before auditing again rather than treating the source-change failure as an editing error.
- Inspect
issueswhenevermatches_planis false, address the reported differences, save the timeline, and rerun the audit. Follow a passing result with visual review, since agreement with a plan does not prove visual accuracy. - Do not use
argumentsto introduce relaxed matching thresholds or automatic repairs. No such controls are exposed by the underlying audit operation.
OpenKatana · Audit reference plan Common Errors and Solutions:
Save a timeline before auditing
- Explanation: This is the explicit error raised when the selected project has no saved timeline. The audit needs saved editing instructions to compare with the recorded plan.
- Solution: Save a timeline in the intended project, confirm that
project_ididentifies that project, and run the node again.
unexpected inputs: ...
- Explanation: The node explicitly raises this error when additional named execution fields are supplied that are not part of its declared typed inputs. This concerns extra node execution fields, not a confirmed error format for the contents of
arguments. - Solution: Use only
project_id,arguments, and the optionalafterinput. Remove custom fields added through scripts or modified workflows.
Missing or unreadable recorded reference plan
- Explanation: The audit depends on the project's recorded reference plan. The supplied context identifies its file as
reference-plan.json, but does not show the exact error message produced when that file is absent or unreadable. - Solution: Record a valid reference plan for the selected project before auditing. If the file was damaged or removed, restore it through the supported plan-saving operation using verified requirements.
matches_plan is false after the reference file changes
- Explanation: This is an audit failure rather than a confirmed exception message. The supplied tests show that modifying the source reference after saving its plan causes the audit to fail, even when the timeline previously passed.
- Solution: Restore the original reference if the change was accidental. If it was intentional, visually verify the new reference and record an updated plan before rerunning the audit.
matches_plan is false because text or timing differs
- Explanation: The audit checks literal timed text, and the supplied tests confirm that it reads text from shot layers. Moving text to a different start time can fail the audit even when the wording remains unchanged. The exact issue-message wording is not supplied.
- Solution: Compare the reported issue with the recorded text and frame interval. Correct the text layer's wording, start time, or duration as needed, save the timeline, and audit again.
matches_plan is false because required editing settings differ
- Explanation: The operation checks exact cut frames, font file hashes, and specified shot settings. A visually similar font or effect may still differ from the recorded requirement, and shot requirements are checked against their recorded shot indices. The supplied context does not show the exact messages for these differences.
- Solution: Inspect
issuesand restore the required cut positions, font files, or shot settings. If you intentionally changed the requirements, verify and record a revised plan rather than silently weakening the existing one.
Reference plan was not saved because its requirements were invalid
- Explanation: Plan validation occurs before saving. The supplied test confirms that a plan with cut frames ordered as
[12, 4]is rejected and no reference-plan file is created; this can leave a later audit without the plan it needs. The exact validation error text is not supplied. - Solution: Correct the plan before saving it, including putting cut frames in the required order. Confirm that the save operation succeeds, then rerun the audit.
