SOAK CONNECTOR / Business Central / Documentation

Click here to Download Templates.

Overview

This documentation provides a detailed guide for using the Data Extractor extension for Microsoft Business Central. This extension allows businesses to seamlessly extract data from Business Central through API calls, enabling efficient data retrieval for reporting, analysis, and integration with other systems. The Data Extractor simplifies accessing Business Central’s data and streamlines the process of exporting data into various formats for use in external applications or data warehouses.

Key Features

  • Customizable Data Extraction: Define and customize the data you want to extract from Business Central, including tables, fields, and filters, ensuring you get precisely the data you need.
  • API-Based Data Retrieval: Use standard Business Central API endpoints to extract data securely and efficiently, leveraging the power of Business Central’s REST API capabilities.
  • Automated Data Export: Schedule data extraction processes to run at specified intervals, ensuring your data is always up to date without manual intervention.
  • Data Transformation and Filtering: Apply filters, transformations, and mapping rules to the data being extracted to ensure that only relevant data is exported in the required format.
  • Integration-Ready Formats: Export data into various formats such as JSON, CSV, or XML, making it easy to integrate with third-party systems, business intelligence tools, or data storage solutions.

Benefits

  • Streamlined Data Access: Simplifies access to Business Central’s data through predefined API queries, allowing users to retrieve data without needing to understand complex API structures.
  • Time-Saving Automation: Automate regular data extraction tasks, reducing the need for manual exports and ensuring that your external systems have access to the most current data.
  • Enhanced Data Analysis: Export data in formats compatible with data analysis and business intelligence tools, enabling deeper insights and better decision-making.
  • Secure and Compliant: Utilize Business Central’s secure API framework, ensuring that data is extracted safely and in compliance with Microsoft’s data access standards.

Prerequisites

  • An active Microsoft Business Central subscription.
  • API access permissions in Business Central with a valid API key or OAuth setup.
  • Basic understanding of Microsoft Business Central’s data structure and API capabilities.

Installation and Setup

  1. Download and Install: Obtain the Data Extractor extension from Microsoft AppSource or directly from our website.
  2. API Configuration: Set up API credentials within the extension’s configuration page by entering your API key or OAuth client credentials.
  3. Define Extraction Rules: Specify which tables and fields to extract from Business Central. You can define filters, sorting rules, and data transformation settings.
  4. Test API Connection: Use the built-in testing tool to ensure that the Data Extractor can connect to Business Central and successfully retrieve data.
  5. Set Up Data Export Schedule: Schedule data extraction jobs to run at intervals that match your business needs (e.g., daily, weekly, or monthly).

How to Use the Extension

1. Setting Up a Data Extraction Job

  • Go to the Data Extractor section within Business Central.
  • Click Create New Job and specify the name and description of the job.
  • Select the tables and fields you wish to extract (e.g., customers, sales orders, inventory).
  • Define any filters (e.g., date range, customer segments) to limit the scope of the data being extracted.
  • Choose the output format (e.g., JSON, CSV, XML).
  • Click Save to store the job configuration.

2. Running a Data Extraction Job

  • Navigate to the list of saved extraction jobs in the Data Extractor.
  • Select the job you want to run and click Execute.
  • The extracted data will be generated in the specified format and can be downloaded directly from the interface or saved to a configured destination (e.g., FTP server, cloud storage).
  • Review the extracted data to ensure it meets your needs.

3. Scheduling Automated Exports

  • Open the Schedule tab in the Data Extractor.
  • Choose the extraction job you want to automate.
  • Set the frequency (e.g., daily at 12:00 AM).
  • Define the destination where the exported data will be saved (e.g., Azure Blob Storage, SFTP server).
  • Click Enable Schedule to activate the automated extraction.
  • The Data Extractor will now run the job according to the defined schedule and automatically save the data to the designated location.

Troubleshooting and Support

  • Connection Issues: If you encounter problems connecting to the Business Central API, verify that your API credentials are correct and that the user account has the necessary permissions.
  • Incomplete Data Exports: Ensure that the fields and filters are correctly defined in your extraction job to include all the data you need. Check API rate limits to ensure your queries are not being throttled.
  • Slow Data Retrieval: Large data sets may take longer to extract. Consider optimizing your filters to reduce the volume of data being pulled or adjusting the schedule to run at off-peak times.

Best Practices

  • Minimize Data Volume: Use filters to limit data retrieval to only the necessary records, which can improve performance and reduce API call usage.
  • Secure Data Transfer: Use secure methods such as HTTPS and encrypted storage options when exporting data to external systems.
  • Monitor API Usage: Regularly monitor your API usage to avoid exceeding rate limits or incurring additional costs from your Business Central subscription.

Documentation

You can find the documentation below.

SOAK CONNECT – DokumentationDownload

Support and Contact Information

For further assistance, please reach out to our support team at support@soak.dk or visit our online documentation portal. Our support team is ready to help with setup, configuration, and any questions you may have regarding the Data Extractor extension for Business Central.