> For the complete documentation index, see [llms.txt](https://sharpsync.gitbook.io/sharpsync/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sharpsync.gitbook.io/sharpsync/data-sources/propel-plm/getting-started.md).

# Getting Started

*This document is a work in progress*

### Configuration

To configure a Propel instance you need:

* The base API path of your Propel cloud instance which is of the form: `https://{propel-instance}.my.salesforce.com`
* Propel uses the OAuth 2.0 protocol to authenticate, therefore, a code grant url (OAuth Url), a refresh token url (OAuth token Url), a Salesforce Connected App Consumer Key (OAuth Client ClientId) and Consumer Secret (OAuth Client Secret), and the OAuth Scopes need to be supplied, they are of the form:
  * OAuth Url: `https://{propel-instance}.my.salesforce.com/services/oauth2/authorize`
  * OAuth token Url: `https://{propel-instance}.my.salesforce.com/services/oauth2/token`
  * OAuth Client ClientId: The Salesforce Connected App Consumer Key from the [previous](/sharpsync/data-sources/propel-plm/oauth-setup.md) step
  * OAuth Client Secret: The Salesforce Connected App Consumer Secret from the [previous](/sharpsync/data-sources/propel-plm/oauth-setup.md) step
  * OAuth Scopes: `full api web refresh_token offline_access`

### Setup Propel Data Source

* Login on the application
* Navigate to `Data Sources`
* On the right > Select Propel > Add
* Update the Server Url with your instance's url, then click on the `UPDATE` button
* Click on the configure button
* On the first tab `Authentication`, select the `OAuth 2.0` authentication type then enter the OAuth credentials
* On the second tab `BOM Configuration`, select the preferred BOM child revisions selection option
* Click the `Save` button
* Click the `Authenticate` button

### Setup Propel Property Mappings

* Navigate to `Property Mapping`
* After creating/adding your[ Property Mappings ](/sharpsync/fundamentals/property-mappings.md)from your primary/CAD source, select the corresponding Propel property from the drop down selection boxes.

### Notes:

In the current implementation of the SharpSync Propel Module:

* New Propel items are are already created with at least a Name and Category prior to exporting to SharpSync.
* Existing Propel item Names or Part Numbers (Propel property name: `"Name"`) cannot be edited.
* Existing Propel item Categories (Propel property name: `"PDLM__Category__c"`) cannot be edited.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://sharpsync.gitbook.io/sharpsync/data-sources/propel-plm/getting-started.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.