Skip to main content

BI Endpoints Setup

In Business Central, search for BI Endpoints Setup. This page activates the subscription and holds the settings that apply to every endpoint in the environment.

Activate the subscription​

The API answers only once a subscription is activated. Until then every data request fails with BI Endpoints application is not activated in Business Central.

  1. Fill in the subscription admin name and email.
  2. Click Create Subscription and choose a tier:
    • Free — posted G/L entries and sales invoices with the chart of accounts, customers and items, for basic reporting.
    • Premium — every endpoint, custom endpoints and the Management API. Choosing Premium starts a 14-day trial of the full functionality. Afterwards you can subscribe to Premium or switch to Free.
info

Contact support@datawareness.com to activate a Premium subscription after your trial ends, or to switch tier.

See Free and Premium for what each tier includes. Calling a Premium endpoint on Free returns This endpoint requires a Premium subscription.

API output language​

API Output Language controls the language used to render enum and option values — such as documentType and status — across all endpoints, and in the business keys captured in the deletedEntries log. Pick the language from the drop-down; the Language field shows its name.

Choose it once, before you build reports: a report that groups on a status value expects the same text on every refresh.

Delete tracking​

Deleted records are tracked by default for every BI endpoint, so incremental loads can remove them downstream. They are served through the deletedEntries endpoint; see Incremental loads and deletions.

  • Disable Delete Tracking switches tracking off for every endpoint.
  • To switch it off for a single endpoint, open the endpoint from the BI Endpoints list and turn off Delete Tracking on its page.
  • Empty deleted records clears the log.
  • Captured records are removed automatically according to the retention policy for the deleted-entries log, which you can adjust under Retention Policies.

Management API​

Custom endpoints can be configured through the Management API by the same app registration that reads the BI endpoints; no extra permission set is needed. The Management API is enabled by default. Switch on Disable Management API if custom endpoints should only be maintained by administrators in Business Central. The setting applies to every company in the environment and does not affect the Custom BI Endpoints page.

The section is shown on a Premium subscription only, because the Management API is not available on Free.