Skip to content

Latest commit

 

History

History
217 lines (134 loc) · 7.27 KB

onshape.md

File metadata and controls

217 lines (134 loc) · 7.27 KB
icon description
chart-tree-map
[docs in progress]

Onshape

Onshape Setup

  • Onshape App Store Subscription
  • Setting up Onshape
  • Configure the authentication options
  • Mapping values to ERP
  • Export Assembly or Part from Onshape
  • Troubleshooting

Note: Onshape integration for SharpSync is not currently supported for free versions. For SharpSync to work, you need to create custom properties in a company in Onshape. This is only possible with the Professional or Enterprise versions of Onshape. This is a limitation of Onshape.

Onshape App Store Subscription

  • Find and subscribe to the SharpSync.net OnShape app in the Onshape App Store

  • For Onshape Enterprise users, make sure to add the related Onshape users to the list of users that have permission to access the Onhsape App Store

Setting up Onshape Data Source in SharpSync

  • In the Navigation Bar, select Data Sources
  • On the right (in Data Sources), select OnShape as the Data Source and click ADD DATASOURCE
  • Change the Server URL to:
https://cad.onshape.com
  • Scroll to the bottom of the page and click UPDATE
  • Change the Authentication Type to OAuth2
  • Configure the authentication options
  • Click AUTHENTICATE. If the configuration is successful, the Authentication Status will update and show Connected.
  • Configure the Primary and Secondary Identifiers as follows:
    • Primary Identifier: partNumber
    • Secondary Identifier: name

After successfully authenticating with OnShape, the update should automatically trigger. If it does not, click the Update button.

The custom fields from OnShape have now successfully been pulled into SharpSync.

Please make sure to set up your Secondary Data Source. For more information, refer to the other Data Sources listed in the Navigation Bar.

Configure the authentication options

  • Click CONFIGURE
  • Choose one of the two paths below depending on your version of our product:

{% tabs %} {% tab title="Professional or Free version" %} Base API path

The Base API we use to connect

  • Leave the default link to the OnShape instance as-is:

https://cad.onshape.com/api

Authentication Types (see below**)

The type of authentication method to use when authenticating with OnShape.

We only support:

OAuth 2.0

  • Select OAuth 2.0

Once you have selected the Authentication Type, the remainder of the form should autocomplete to the following:

Image of configuration settings

Configuration Settings

  • Click SAVE to save and close the form {% endtab %}

{% tab title="Enterprise" %} Base API path

The Base API we use to connect

  • Fill in the values for your enterprise name. This means that, in the url, instead of

https://cad.onshape.com/api

you will have

{% code fullWidth="false" %}

https://{enterpriseName}.onshape.com/api

{% endcode %}

Authentication Types (see below**)

The type of authentication method to use when authenticating with OnShape.

We only support:

OAuth 2.0

  • Select OAuth 2.0

Once you have selected the Authentication Type, the remainder of the form should autocomplete to the following:

Image of configuration settings

Configuration Settings

  • Click SAVE to save and close the form {% endtab %} {% endtabs %}

Please make sure to set up your Secondary Source. For more information, refer to the other Data Sources listed in the Navigation Bar.

Once completed with the setup for both Primary and Secondary Data Sources, proceed to setup Property Mappings.

Mapping values to ERP

Mapping the URL to a field in the ERP

Onshape is an online Data Source, so you can map the URL of the document to a field in the ERP.

To map an Onshape document URL to a property in the ERP do the following:

  • Create a new property mapping
  • Onshape property: (Unmapped)
  • ERP property: {nameOfField} e.g. document_url
  • Rendering Type: URL
  • Create a new rule: Text manipulation
  • Rule value: return rowData.primaryViewHref;

  • Click Save
  • Reload the BOM to display in the BOM Comparison screen
  • Click Submit to update

Export Assembly or Part from Onshape

  • You can export a BOM from Onshape to SharpSync through the following methods:

    • The Onshape Tree Structure Assembly Context Menu
    • The Onshape Assembly Tab Context Menu
    • The Onshape Part Studio Tab Part Context Menu

Troubleshooting

Could not find data source

The following response in the network tab with a 400 status code

Request Method: GET
Status Code: 400 Bad Request

Could not add file lookup to the server
{"message":"Invalid id specified or bad request"}

OR

{"message":"Could not find datasource for organization {uuid} and module Onshape","data":[]}

You are trying to sync to an organization in SharpSync that has not yet been created.

First, create the organization by following the setup steps in Data Sources.

Cannot get properties

The following response in the network tab with a 500 status code

Request Method: GET
Status Code: 502 Bad Gateway

{
    "message": "Could not find the Onshape company that the user belongs to when loading the BOM"
}

This means that you're attempting to use SharpSync with a free version. Free versions are currently not supported due to a limitation in Onshape that you cannot create custom properties (True at the time of writing this)

Cannot pull Onshape BOM

The following response in the network tab with a 502 status code

{
    "message": "Could not pull the bom from Onshape - request was Forbidden. Check that the document hostname/origin matches the datasource server hostname"
}

Let's say the enterprise name is starkindustries.onshape.com .

Check:

  • The hostname is configured correctly in the datasource (e.g. cad.onshape.com vs starkindustries.onshape.com)
  • The oauth hostnames all match
    • For free version: oauth.onshape.com and NOT cad.onshape.com
    • For enterprise version starkindustries.onshape.com and NOT oauth.onshape.com