Skip to main content

Workflow Service Panel

Workflow Definitions Folder Commands​

Create Workflow Definition​

Creates a new WorkflowDef in the selected project.

The creation form prompts for a name, description, user type, and task definitions. WorkflowDef names are required and cannot contain whitespace.

Task definitions are provided as a JSON array. Supported task _type values include:

  • REST_CONNECTOR
  • SCRIPT_EXECUTION
  • USER_INPUT
  • SWITCH
  • FORK_JOIN
  • DO_WHILE
  • HAYSTACK
  • MQTT_PUBLISH
  • AI_CONVERSE

Create Model Import Workflow​

Creates a BIMPK model-import WorkflowDef named Import_BIMPK_Models when the project does not already have a workflow that uses the workflow-adapted import helper script.

The command uploads or versions that import helper script, then creates three SCRIPT_EXECUTION tasks: import the model from a BIMPK file, post-process the imported model, and migrate file-item relations.

If a model import workflow already exists, the command reports its name and still versions the import helper script. It does not create a second WorkflowDef.

After the workflow exists, use Run Workflow with Input and choose the .bimpk file from the project File Service root.

Convert Orchestrator to Workflow​

Creates a new WorkflowDef from a Datasources orchestrator in the same project. The original orchestrator is not modified or deleted.

The command lists the project's orchestrators. After you select one, it maps supported orchestrator steps to Workflow task definitions and opens a preview where you can review the proposed WorkflowDef, schedules, and conversion warnings before creating.

Notes:

  • Instant orchestrators are converted to an asynchronous WorkflowDef. Instant request/response orchestrators may be a better fit for an Object Model API endpoint.
  • Components with no Workflow equivalent are omitted and listed in the preview warnings.
  • 3-field orchestrator durations map to Quartz where a single field increment fits: seconds or minutes 1–59, hours 1–23, or whole days 1–31 (for example 24 0 0 becomes daily 0 0 0 * * ?). Intervals such as 90 minutes are omitted with a warning. You can edit _runInterval in the preview before creating.
  • BIMPK import orchestrators that use the importHelper script are mapped to SCRIPT_EXECUTION tasks that call a workflow-adapted import helper. On Create, that script is uploaded or versioned. The original importHelper script used by the orchestrator is left unchanged.

Workflow Definition Commands​

Run Workflow​

Starts a new run for the selected WorkflowDef.

When the run is created, the extension opens the returned WorkflowRun JSON as a read-only document and shows the run ID and status.

Run Workflow with Input​

Starts a new run for the selected WorkflowDef after prompting for optional input.

You can optionally choose a file from the project File Service root. Selecting a file adds _fileId and _fileVersionId (the file's tip version) to the run _inputParams. Use this to run a model import workflow against a .bimpk in the File Service root.

You can also supply a JSON _inputParams object. Values from the selected file are merged into that object.

This file picker is only on Run Workflow with Input. Run Script with Input still accepts JSON or JavaScript input only.

Show Workflow Runs​

Opens the Workflow Runs tab in the Twinit Console for the selected WorkflowDef.

The console shows the 20 most recent runs, including status, created time, updated time, duration, tasks, task logs, and the run JSON.

View Definition JSON​

Opens the selected WorkflowDef as a read-only JSON document.

Delete WorkflowDef​

Deletes the selected WorkflowDef from the Workflow Service after confirmation.

Schedules Folder Commands​

Create Schedule​

Creates a time-based schedule for the selected WorkflowDef.

The schedule form prompts for a Quartz cron expression, a time zone, and optional _inputParams JSON. The cron expression must contain 6 or 7 whitespace-separated fields.

For example, 0 0 12 1/1 * ? runs the WorkflowDef daily at noon. The time zone defaults to UTC when not provided.

Schedule Commands​

View Schedule JSON​

Opens the selected schedule as a read-only JSON document.

Delete Schedule​

Deletes the selected schedule trigger after confirmation.

If the deleted trigger is the last trigger on its schedule job, the Workflow Service also deletes the job.

Workflow Runs​

The Workflow Runs tab in the Twinit Console is opened from the Show Workflow Runs command on a WorkflowDef.

From this tab you can refresh recent runs, select a run to inspect its tasks, view logs for workflow tasks, and review the selected run JSON.