Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] - Update BYOD page #6207

Merged
merged 4 commits into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 31 additions & 5 deletions website/content/excel/data-connectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,29 +18,55 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

OpenBB Add-In for Excel allows you to access your [data connectors](https://docs.openbb.co/pro/main-menu/data-connectors) from OpenBB Terminal Pro inside Microsoft Excel. This can be done using the [OBB.BYOD](https://docs.openbb.co/excel/reference/byod) function.

To access data from a [single widget](https://docs.openbb.co/pro/main-menu/data-connectors/single-widget) use:
## [Single widget](https://docs.openbb.co/pro/main-menu/data-connectors/single-widget)

```excel
=OBB.BYOD("widget_name")
```

To access data from your own [backend](https://docs.openbb.co/pro/main-menu/data-connectors/integrate-your-own-backend) use:
:::info

- Make sure your widget is setup in the OpenBB Terminal Pro.

:::

## [Own backend](https://docs.openbb.co/pro/main-menu/data-connectors/integrate-your-own-backend)

```excel
=OBB.BYOD("widget_name","backend_name")
```

If your backend supports it is possible to pass a symbol, date or other optional parameters:
If your backend supports it is possible to pass a symbol, a date or other optional parameters:

```excel
=OBB.BYOD("widget_name","backend_name","my_symbol","my_date",{"param1":"value1","param2":"value2", ...})
=OBB.BYOD("widget_name","backend_name","my_symbol","YYYY-MM-DD",{"param1":"value1","param2":"value2", ...})
```

:::tip
The easiest way to pass optional parameters is to write them into cells and reference them in the function. For example, `=OBB.BYOD(...,A1:B2)` where A1 contains "param1", B1 "value1", A2 "param2", B2 "value2" and so on.
:::

#### Additional notes
:::info

- Make sure your backend's CORS settings allow requests coming from <https://excel.openbb.co>.
- Requests via HTTP will be blocked by Excel. So if you are using the Add-in for Excel on Mac or Office on the web with Safari browser you need to run your backend via HTTPS.

:::

## [Native integrations](https://docs.openbb.co/pro/main-menu/data-connectors#native-integrations)

Supported native integrations:

- database
- snowflake

```excel
=OBB.BYOD("widget_name","native_integration")
```

:::info

- Make sure your OpenBB Data Connector is properly configured and the widget is setup in the OpenBB Terminal Pro.
- Native integrations are available only for Excel on the web or Windows.

:::
Loading
Loading