Skip to main content

Quick Start

Build one workflow: form, condition, human approval, then notification. Run it once.

Prerequisites​

  • Your account can edit and run workflows. The approver can approve execution records.
  • The notification step needs at least one channel in System Management, such as email.
  • Job execution is optional for this walkthrough. If you add it later, host and script permissions follow Job Management.

Create the workflow and trigger​

  1. Open Workflows, create a workflow, and name it. It belongs to the current organization.
  2. On the canvas, the first node must be a trigger.
  3. Choose Form. Add at least one text field, such as change description.
  4. Save. The form trigger provides a page. Submitting it starts a run.

UI Guide:

Screenshot to be added.

  • What to check: Later nodes can reference form fields only after the trigger exists.

Add a condition and an approval​

  1. After the trigger, add Condition.
  2. Add structured rules. Multiple rules combine as match all or match any. The canvas has only matched and not matched exits. It does not create one exit per rule.
  3. Pick the left value from an upstream field, such as the form description or the execution id. Do not type a script expression.
  4. On the matched exit, add Human approval. Enter a title and at least one candidate who can sign in.
  5. On the approved path, add Notification. Choose a channel from System Management. The title and body can reference upstream fields.

Run and approve​

  1. Open the form, enter the change description, and submit.
  2. Find the run in Executions. The state should be waiting for approval.
  3. The approver opens the waiting items on Home, or switches Executions to Waiting for my approval.
  4. Open the detail and review the title, candidates, and approval context. Approve to continue and send the notification. Reject only after entering a reason.
  5. The finished record is succeeded, failed, or terminated. Stop a test run manually if it stays in the middle.

Use another trigger​

  1. Schedule: Set the frequency. A run starts without opening the form.
  2. Webhook: Enable it and give the URL to the external system. Use wait-for-result when the caller needs the workflow output.
  3. NATS: Enter the platform channel that already carries events such as Alert Center messages. Do not put secrets in the workflow description.

When the workflow must touch a host or create a file​

  1. Job execution: Choose authorized targets and a Linux or Windows script. The node returns a JSON envelope for later nodes. It changes the host, so use a test target first.
  2. HTTP request: Set the method, full URL, and parameters. Runtime checks block unsafe addresses and oversized responses.
  3. Agent or intent classification: Choose an OpsPilot agent or model available to the current organization. Intent classification needs the intent list first.
  4. Memory read or write: Choose a memory space available to the current organization. Read pulls context into later nodes. Write stores this run's result.
  5. Document rendering: Fill a Word or Excel template from structured data. A notification node can attach the file.

Verify​

  • The execution shows the trigger type, starter, and each node's state.
  • After approval, the channel receives the text and the form field values match the submission.
  • Rejection follows the rejection path and does not run the approved path.
  • Home trend and recent runs match the execution list.