CAD

Two Onshape integrationsCopy Anchor Link

Carbon ships two Onshape integrations side by side. They share nothing: each is its own Onshape OAuth application, with its own connection, its own credentials and its own record of which Carbon items are linked. A company can connect either, both, or neither, and disconnecting one never affects the other.

Onshape Government is a third, pull-only variant of Onshape for the ITAR and FedRAMP edition, connected through a private OAuth app your Enterprise owns; see Onshape Government.

Onshape V2 is the one to use for the panel. If the Carbon icon appears in Onshape but the panel reports that nothing is connected, the company connected Onshape and not Onshape V2 — connect V2 as well.

Set up the Onshape applicationsCopy Anchor Link

Everything below is done once per Carbon deployment, by whoever operates it. It is the same for cloud and self-hosted Carbon. Each integration has its own OAuth application in the Onshape developer portal, and each reads only its own variables:

Set up Onshape V2 to use the panel. Set up Onshape only if you want released-asset sync.

https://<erp-host>/onshape/panel?documentId={$documentId}&wv={$workspaceOrVersion}&wvId={$workspaceOrVersionId}&elementId={$elementId}&partNumber={$partNumber}&revision={$revision}&nodeId={$nodeId}&occurrencePath={$occurrencePath}&configuration={$configuration}

Connect a companyCopy Anchor Link

In Carbon, open Settings → Integrations. Both Onshape cards are in the CAD category.

If the popup ends in an error:

Onshape GovernmentCopy Anchor Link

Onshape Government is Onshape's ITAR and FedRAMP edition. Because it has no public App Store, your Enterprise must create a private OAuth app for Carbon. After connection, it supports document browsing, bill-of-materials imports, and released-asset synchronization.

A company can connect to only one Onshape environment. Disconnect the current integration before connecting the other.

The Carbon panel in OnshapeCopy Anchor Link

Open a Part Studio, an assembly or a drawing and click the Carbon icon in the right panel. Press Sign in to Carbon: a popup on Carbon's own origin signs you in (or sends you through the normal login first) and closes itself. The session lasts up to 12 hours and is held only in that browser tab.

The panel works in the Carbon company you are signed in to in the Carbon tab the popup used; the top of the panel shows which. To push into a different company, switch company in Carbon, then press Sign out and Sign in to Carbon in the panel.

The panel has three pages:

• Parts, Assembly or Push, after the element you have open. A drawing has nothing to push here; its PDF comes in with a release.
• Releases, for the whole document.
• Fields, on a Part Studio or an assembly, for users with the settings: update permission in Carbon.

Pushing works in a workspace or a version. In a microversion the panel shows status only.

StatusCopy Anchor Link

Each part or BOM line shows its state before anything is pushed:

An assembly's bill of materials shows as a tree, collapsed to the top level, the way Onshape's structured BOM does.

Review before anything is writtenCopy Anchor Link

Every push is two steps. Pressing Push shows a review of what Carbon would do; nothing is written yet:

• items that will be created, with the values they will get. Replenishment, default method type and tracking type can be changed here; the item ID and revision come from Onshape. Each mapped value shows the Onshape property it came from (see Fields); anything not mapped starts from the push defaults.
• items that will be linked to an existing Carbon item by part number, or updated because Onshape changed. The review lists the values the push replaces (fields set to Update on every push) and the Onshape values Carbon keeps (fields set to Set at creation).
• for an assembly, each make method with the lines it gains, the lines a previous push wrote that change, the lines added by hand that the push takes over, and the ones it keeps.
• for a release, every revision it creates and the change notice it uses.

Push n to Carbon applies the review as shown; Cancel writes nothing. A review is held for 15 minutes; after that, Review again. A choice made in the review is written to Carbon only; Onshape keeps its values.

Push a partCopy Anchor Link

Creates or updates the Carbon item for an Onshape part: the part number becomes the item ID, plus name, description, revision, the 3D model and a thumbnail. Pushing again after a change updates the item. Pushing an unchanged part writes only mapped values that differ, and exports nothing. In a workspace, a part changes when a Part Studio, Variable Studio or Feature Studio in its document does; editing a drawing or an assembly leaves it unchanged. Parts need a part number in Onshape first. Push all pushes every numbered part in the Part Studio, at most 50.

After the push the item is a Carbon item like any other, and every field stays editable. A later push replaces only the fields set to Update on every push on the Fields page. The item page shows an Onshape card with the link, the fields a push replaces, Open in Onshape, and Detach, which removes the link so pushes stop updating the item. The card shows links made by the panel only.

Push an assemblyCopy Anchor Link

Pushes the assembly and its bill of materials: every item in the BOM is created if missing, and the BOM lands on the assembly's make methods, sub-assemblies included. A push changes only what Onshape changed: lines a previous push wrote are updated or removed. A line you added by hand for a part Onshape's BOM also lists is taken over; its quantity follows Onshape, and its operation and scrap stay. A hand-added line for a part Onshape doesn't list is left alone.

An assembly with more than 1,500 distinct parts is refused as a whole; Push this level only pushes its top-level BOM, with each sub-assembly as one line.

Items in the BOM that are not yet linked to an Onshape part are linked to theirs. Every item linked to its BOM row takes the values set to Update on every push. Only values Onshape has are written, so an empty Name or Description cell never blanks Carbon's text. An item already linked to a different Onshape part keeps that link, and the push writes nothing to it.

Buy or Make. For a new item, the first of these that gives a value wins:

1. your choice in the review,
2. the Onshape property mapped to Replenishment (see Fields),
3. a BOM row with components is Make,
4. a part from Onshape's Standard content library is Buy,
5. the push default.

A sub-assembly whose Subassembly BOM behavior is Show assembly only is listed without components, so the push writes no BOM for it. It says nothing about Buy or Make. The review warns when an item's Buy or Make and Onshape's BOM disagree: a Buy item that would get a BOM, or a Make item Onshape shows as one unit.

A released make method is never edited. When an assembly's method is Active and Onshape's BOM differs from it, the push takes a new Draft version and writes there, the same way a Version change works in Carbon. Nothing live moves until someone releases the Draft. Pushing again writes into the same Draft. The push result lists each new Draft as not yet live.

STEP models. Every assembly push exports STEP models in the background: the assembly's own, and one for each part and sub-assembly in the BOM, onto its item. There is nothing to pick.

• A row gets no model when its item is from Onshape's Standard content library, released in Carbon, or linked to a different Onshape part, or when one Onshape part is listed under two part numbers. That item's model comes from its own push.
• A model the item already has from the document as it is now is not exported again. Editing a Part Studio, Variable Studio or Feature Studio changes every model in the document; editing an assembly, only assembly models; editing a drawing, none.
• A model replaces the item's current one, as a part push does.
• The BOM's models export two at a time per company and appear on the items a few minutes after the push. Every model exported spends Onshape API calls.

Drawings. The same push attaches every drawing in the BOM's documents, as a PDF, to each item the drawing shows. A drawing of an assembly goes to that assembly only, not to its parts; any other drawing goes to every part it shows. A PDF is named after the drawing in Onshape and appears in the item's Files.

• A drawing goes only to items that take a model in the push, and to the assembly itself.
• A drawing kept in a document outside the BOM, such as a separate drawings document, is not found.
• A drawing the item already has from the document as it is now is not exported again. Editing the drawing, or the part or assembly it shows, exports it again.
• Each drawing is exported once, whatever the number of items it goes to.
• Two drawings with the same name on one item are told apart by a number: Drawing 1.pdf, Drawing 1 (2).pdf. Another file on the item with the same name, such as one uploaded by hand, is never overwritten.
• Renaming a drawing in Onshape renames its PDF in Carbon on the next push.

Push a releaseCopy Anchor Link

The Releases page lists the document's 20 newest Onshape releases, each marked In Carbon, Partial or Not in Carbon. Pushing one:

• creates a Carbon revision of every released part and assembly at the released revision letter, copied from the revision below it when Carbon has one,
• writes each released assembly's BOM, as of the released version, to the new revision's method,
• takes each released item's mapped values at its released version,
• attaches models and thumbnails at the released version, and each released drawing as a PDF named <part number>-<revision>.pdf on its part,
• attaches every other drawing in the document, as it was at the released version, to each released part or assembly it shows, as on an assembly push.

The new revisions go on one draft change notice, named after the release. They stay inactive until you release that notice in Carbon, which activates them and supersedes each previous revision. Pushing the release again adds to the same notice while it is open and not waiting for approval, and creates nothing twice; otherwise the push starts a new notice. BOM components the push has to create are not on the notice.

A release with only a drawing reads In Carbon once its PDF is attached. Release management needs an Onshape company account; without one the page says so.

FieldsCopy Anchor Link

The Fields page maps Onshape properties (Vendor, Project, Material, your company's custom properties) onto Carbon. A property can set an item field or a custom field on the part. The page lists the properties of the element you have open, but the mappings belong to the company and apply to every push. It lives in the panel because Onshape lists properties only from inside a document.

The page starts with fixed rows: Part number and Revision always come from Onshape, and Name and Description each have a mode (below). Then come the item fields with their push defaults, the values a new item gets when no property sets them:

• A list field has a translation: each row turns an Onshape value into a Carbon value. The rows start with Carbon's own values, so an Onshape list with the same options needs no setup. Set a row to No value to leave the field to the next rule. An Onshape value with no row is called out in the review and not written.
• A Unit of Measure value that matches a unit's code or name needs no row.
• Item fields are written the way the item page writes them. Changing Replenishment also sets the method that goes with it. A change of Replenishment, method or sourcing also updates the item's lines on Draft BOMs; a change of tracking type also updates open jobs, receipts, shipments and transfers.

Custom fields: create the field in Carbon first, then select it here. Text, list and object properties map to Text fields, booleans to Yes/No, numbers to Numeric, dates to Date. Onshape's computed, user, file and category properties can't be mapped; the page names them under the list. A property with no Carbon field of its type says which part custom field type to add.

Each Carbon field takes one property. A field another property already sets stays in the list, greyed out, with that property's name.

When Onshape writes a field. Each mapping, and the item's Name and Description, has one of two modes:

• Set at creation (the default): Onshape fills the field when a push creates the item. After that, Carbon owns the field and later pushes don't change it.
• Update on every push: every push replaces Carbon's value with Onshape's, including edits made in Carbon. An empty custom field property clears the Carbon field; an empty item field or description is never written.

Set up Buy or Make. Onshape has no Buy/Make property. Create a list property in Onshape, for example Make or buy, with the options Buy, Make, and Buy and Make. Map it to Replenishment here and set the value on the parts your company buys. Parts from Onshape's Standard content library (fasteners and other hardware) come in as Buy when no property gives a value.

• Carbon matches a list value by its display name in Onshape, or by its value when it has no display name.
• An Onshape default is a value: every part with no value of its own sends the default. With Update on every push, a default replaces Carbon's value on every linked item nobody set in Onshape. Leave the Onshape default empty to let the push defaults decide for new items.
• A property that applies only to parts has no value on assembly rows. Carbon writes nothing there.

Refresh re-reads the properties and the field list. Save saves the map and the push defaults together.

Troubleshooting the panelCopy Anchor Link

When the panel can't read from Onshape, or an assembly's BOM is missing a column the panel needs, the error has Show details and Copy details: what Carbon asked Onshape and what Onshape answered, including the Onshape address, its status and message, and for a BOM that can't be read, the column headers Onshape returned. Paste it into a support request. It never contains a token or a cell value.

RelatedCopy Anchor Link