OCTAGON PLMSupport
Support  /  Command & automation

Verb reference

All eleven verbs, what each does, and an example of each.

Eleven verbs. Everything else is a filter or a flag.

VerbDoes
findSelect a working set. Usually the start of a chain.
exportMetadata out to CSV, XLSX or your own template.
downloadFiles and drawings out as a package.
compareBOM-to-BOM or revision-to-revision differences.
createNew parts, records or projects in batch.
setUpdate field values across a selection.
checkout / checkinLock and release for editing.
linkRelate parts to suppliers, documents or projects.
reportGenerate a formatted report.
backupSnapshot to storage you control.
syncPush to or pull from connected systems.

Worked examples

Find the gaps

find part where lifecycle = 'released' and supplier.price is null

Every released part nobody has priced. This is usually the whole explanation when a rolled cost looks too low.

Export for a specific audience

export part where project = 'HALO6' --template 'erp-daily'

Runs a saved column template rather than re-picking columns each time.

Package files

download file where part.number like 'BLD%' and file.type = 'pdf'

Every drawing for a part family, as one archive.

Create in batch

create part
  848484   "Housing, lower"
  4948484  "Seal, shaft, 12mm"

Several parts in one action, each as a draft.

Flags

FlagEffect
--dry-runStop at the preview permanently. Never executes.
--atomicIf any row fails, the whole batch rolls back rather than half-applying.
--formatFor exports and reports: xlsx, csv or pdf.
--templateUse a saved column template.
--levelFor BOM operations: top or all.
--destinationWhere output is written.
Still stuck?

Email [email protected] and a person will pick it up. Include the part number and what you were doing — it saves a round trip.