> For the complete documentation index, see [llms.txt](https://docs.dynalogic.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.dynalogic.com/birds-document-warehouse-product-overview/d365-business-central/configuration-9a-raptor-pages.md).

# Configuration: 9A Raptor Pages

On this page, you will find an overview of all 9A Raptor Pages in Business Central. These pages are mainly used for configuration and setup, but can also be informative pages.

Tell me function: '9A Raptor'

<figure><img src="https://1567270722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbMdBZV3cNP56k0aYYCI6%2Fuploads%2Fgit-blob-7b480a960a95e0fa4e6efbe86873a44e081fe831%2Fimage%20(16).png?alt=media" alt=""><figcaption></figcaption></figure>

* 9A Raptor API Setup
* 9A Raptor Webservices Log
* 9A Raptor Integration Setup
* 9A Raptor Setup (Package) List
* 9A Raptor Email Scenario Setup
* 9A Raptor Document History List
* 9A Raptor Integration Scenarios
* 9A Raptor Document Distribution Setup

## 9A Raptor API Setup

This page specifies the API endpoints that Raptor can use to fetch table data

* The list will be prefilled with the default API endpoints
* Additional custom API's can be added by a BC technical consultant

<figure><img src="https://1567270722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbMdBZV3cNP56k0aYYCI6%2Fuploads%2Fgit-blob-9948504686d21b137314d7038d0103642a13264e%2Fmsedge_HGsoXFCRGS.png?alt=media" alt=""><figcaption></figcaption></figure>

Verify if the right API's are checked as custom API.

| Setting               | Configuration                                                                                 |
| --------------------- | --------------------------------------------------------------------------------------------- |
| Endpoint API          | API endpoints that Raptor can use to fetch data.                                              |
| Filter Field          | Leave blank.                                                                                  |
| Custom API: unchecked | Fetch from the default API endpoint: /api/v1.0/ before BC21, or /api/v2.0/ from BC21 onwards. |
| Custom API: checked   | Fetch from the custom Raptor API endpoint: api/raptor/custom/V1.0/                            |

Select an endpoint: 9A Raptor API Setup Card

* Specify the fields for which you want to track tags
* This is necessary for entity config
* This is for you to decide

<figure><img src="https://1567270722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbMdBZV3cNP56k0aYYCI6%2Fuploads%2Fgit-blob-86869c3dc67ca34ccd71fcf5ffe2a91bd1f001c8%2Fmsedge_o1TqpG1wiu.png?alt=media" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
This needs to be linked one-to-one with the **entity configuration in Raptor**, otherwise the filtering won't work.
{% endhint %}

## 9A Raptor Webservices Log

<figure><img src="https://1567270722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbMdBZV3cNP56k0aYYCI6%2Fuploads%2Fgit-blob-dc53966671666427711f56f31602500e95a0d496%2Fimage%20(167).png?alt=media" alt=""><figcaption></figcaption></figure>

* This is a logging table for errors and the reason a document couldn't be uploaded to Raptor document warehouse.

## 9A Raptor Integration Setup

<figure><img src="https://1567270722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbMdBZV3cNP56k0aYYCI6%2Fuploads%2Fgit-blob-62291d334b1dbdfd497848c80bb4d997e810f689%2Fimage%20(156).png?alt=media" alt=""><figcaption></figcaption></figure>

**General**: see 'Configuration Raptor - BC [https://app.gitbook.com/o/bqSIsQqz4U4PqAwwBN3A/s/Kfypi8e8luNHtfjQhy6p/\~/changes/145/integrations/d365-business-central/configuration-raptor-bc#id-3.-9a-raptor-integration-setup](https://docs.dynalogic.com/pages/31YsGKcLntoV60cQc49Q#id-3.-9a-raptor-integration-setup)

**Event Management**

* Created By System Tag: Tag for Raptor Documents created by printing document from Business Central.
* Delete Incoming Document Attachments: The tag will be used to exclude such documents from being attached to outgoing emails.
* Legal entities Tag: choose a legal entity tag from the taxonomy
  * Used for advanced filtering (output management): link documents based on the legal entity

**Email Management**: Enable integration of Raptor with the base Business Central emailing framework.

**Input Management**: Enable certain fields for Raptor setup in Continia document journals.

* Partially switches off certain Continia functionalities and uses Raptor document warehouse in replacement
* More about this on the following page: [https://app.gitbook.com/o/bqSIsQqz4U4PqAwwBN3A/s/Kfypi8e8luNHtfjQhy6p/\~/changes/160/integrations/d365-business-central/input-management](https://docs.dynalogic.com/birds-document-warehouse-product-overview/d365-business-central/input-management-continia.md)

**Action: Navigate**

<figure><img src="https://1567270722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbMdBZV3cNP56k0aYYCI6%2Fuploads%2Fgit-blob-0da16f6dfdfee72d2beb722da8aa9875f7687bf6%2Fimage%20(197).png?alt=media" alt=""><figcaption></figcaption></figure>

* 1\) go to 9A Raptor Integration Scenarios - page
* 2\) go to 9A Raptor Email Scenario Setup - page
* 3\) go to 9A Raptor Email Scenario Setup - page
* 4\) go to Languages - page : this is crucial for the setup of the advanced filtering for output management
  * NAL Raptor Language Tag: add the corresponding language tag

    <figure><img src="https://1567270722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbMdBZV3cNP56k0aYYCI6%2Fuploads%2Fgit-blob-6312b0717aba8e42f9c65d8906369c1cbf9e82ee%2Fimage%20(169).png?alt=media" alt=""><figcaption></figcaption></figure>
  * Advanced filtering for output management: filter attachments based on the language tag
    * Don't forget to add a language code to your customers or vendors if you want to start filtering based on language tag!
* 5\) go to 9A Raptor Document Distribution Setup - page

## 9A Raptor Setup (Package) List

This page defines packages that can be requested by a Raptor Taxonomy job. This taxonomy job ensures that new tags for certain entities are created regularly and at a fixed time.

For each package you can specify the API endpoints that need to be included. You can choose the API endpoints from the list on the ‘9A Raptor API Setup’ page. The package code will be defined in the taxonomy job.

<figure><img src="https://1567270722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbMdBZV3cNP56k0aYYCI6%2Fuploads%2Fgit-blob-ff76c3fe2fd51964b367aa38f6f182479ef57c86%2Fimage%20(130).png?alt=media" alt=""><figcaption></figcaption></figure>

### *1. Business Central*

<figure><img src="https://1567270722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbMdBZV3cNP56k0aYYCI6%2Fuploads%2Fgit-blob-f00cb2ceb8b9d87d058d55fb9cfa6c68627724ab%2Fimage%20(132).png?alt=media" alt=""><figcaption></figcaption></figure>

1\) This is an example of the setup for a taxonomy job for entities customers, items and vendors.

2\) view API fields

* Make sure each API field has the right name, because this is linked with the entity configuration setup in raptor
*

```
<figure><img src="../../.gitbook/assets/image (133).png" alt=""><figcaption></figcaption></figure>
```

3\) Delta Migration

* For each API In the package we can also specify if all data from the endpoint should be forwarded, or only newly modified/created data (= Delta Migration)
* This setting should be turned on after a full sync by the taxonomy job was completed. If left turned off, the taxonomy job might take exponentially more time as it needs to re-sync all data In the system every time

4\) Last Export DateTime

* Specifies when the taxonomy job last ran

### *2. Raptor : taxonomy job*

<figure><img src="https://1567270722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbMdBZV3cNP56k0aYYCI6%2Fuploads%2Fgit-blob-1f5fd5f98975c3438b71f273135b38b2141fe384%2Fimage%20(137).png?alt=media" alt=""><figcaption></figcaption></figure>

Configuration -> jobs -> add a new job

General

* Cron Schedule: specifies when a job will be executed, according to a specific time schedule
  * Set this up using a site like <https://crontab.cronhub.io/>
* On behalf of: fill in a user
* Delta packager: 'Default Packager'
* Legal Entity: your environment

Authentication

* OAuth 2.0
* Active Directory Tenant: <https://login.microsoftonline.com/**\\><tenantID>\*\*
* Client app id: Azure Application ID
  * See Business Central: Microsoft Entra Application-page (don't forget to remove the brackets)
* Client app secret: Azure app registration secret
* Azure resource: always "<https://api.businesscentral.dynamics.com>"

Delta Fetch Settings

* Package ID: package code from the 9A Raptor Setup (Package) List-page
* Uri: <https://api.businesscentral.dynamics.com/v2.0/**\\><Environment Name>\*\*
  * e.g. Production
* Raptor Base Path: /api/raptor/custom/v1.0/
* Entity Path: /api/v2.0/
* Company ID: look up in BC

  * Companies -> Select company -> Ctrl + Alt + F1 -> 'Id'
  *

  ```
  <figure><img src="../../.gitbook/assets/msedge_nPGxKtD0lD.png" alt=""><figcaption></figcaption></figure>
  ```

Save and activate

**note**: if the job isn't working, try adding the following permission set to the Microsoft Entra Application Card

*

```
<figure><img src="../../.gitbook/assets/image (73).png" alt=""><figcaption></figcaption></figure>
```

## 9A Raptor Email Scenario Setup (output management)

First of all: make sure you enable email management on the 9A Raptor integration setup - page

<figure><img src="https://1567270722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbMdBZV3cNP56k0aYYCI6%2Fuploads%2Fgit-blob-1fb8da70f1c6fca350e5140acf02306c534cb13b%2Fimage%20(160).png?alt=media" alt=""><figcaption></figcaption></figure>

This 9A Raptor Email Scenario Setup - page specifies more functionalities for output management (documents made with BC)

<figure><img src="https://1567270722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbMdBZV3cNP56k0aYYCI6%2Fuploads%2Fgit-blob-22e6490b32efb8506a2702b79ea5b95e596fc838%2Fimage%20(168).png?alt=media" alt=""><figcaption></figcaption></figure>

| Scenario option                | Configuration                                                                                                                |
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
| 1. Email scenarios             | Sales quote, sales order, posted sales invoice, posted sales credit memo, purchase quote, purchase order, sales credit memo. |
| 2. Addressees                  | Predefine To, CC, and BCC per scenario.                                                                                      |
| 3. Subject and attachment name | Predefine these per scenario, using the placeholders below.                                                                  |
| 4. Attachment tags             | Documents with the specified tag are added as attachments.                                                                   |
| 5. Advanced filtering          | Filter which tagged documents are included using the conditions below.                                                       |

**Subject and attachment-name placeholders**

| Placeholder     | Value                                                           |
| --------------- | --------------------------------------------------------------- |
| '%COMPANYNAME%' | Name from Company Information                                   |
| '%DOCTYPE%'     | Document Type                                                   |
| '%DOCNO%'       | Posted Document Number                                          |
| '%PARTNERNO%'   | Internal identification number of the recipient Customer/Vendor |

**Advanced attachment filtering**

| Condition        | Documents included                                                                                                                           |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Link to record   | Documents with the requested tags related to the same record as the entity; for example, sales shipments linked to the posted sales invoice. |
| Link to company  | Documents with the requested tags and the same legal entity tag as the record. Configure this on the 9A Raptor Integration Setup page.       |
| Link to language | Documents with the requested tags and the same language tag as the record. Configure this on the 9A Raptor Integration Setup page.           |

## 9A Raptor Integration Scenarios

<figure><img src="https://1567270722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbMdBZV3cNP56k0aYYCI6%2Fuploads%2Fgit-blob-d04603b5649dd20f788c3cfc5fb4f212e94f5bab%2Fimage%20(102).png?alt=media" alt=""><figcaption></figcaption></figure>

This page specifies the entities on which an integration is built

### *1. Copy setup from other company*

<figure><img src="https://1567270722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbMdBZV3cNP56k0aYYCI6%2Fuploads%2Fgit-blob-3e5ea617b16e1b975926a8275afafc04090ab4d9%2Fimage%20(161).png?alt=media" alt=""><figcaption></figcaption></figure>

You can also copy the integration scenarios from another company within the tenant.

* The list of scenarios must be empty to do this.
* At this moment, the API fields are not copied along. So, don't forget to fill in the API fields on the integration scenario card when you copy from another company.

  * You can do this by configuration package: table ID = 2057757 (NAL Raptor Integration Field)
  * Important! : The primary key is not the first field in this table. When importing the configuration package, make sure to do this without validation.
  *

  ```
  <figure><img src="../../.gitbook/assets/image (162).png" alt=""><figcaption></figcaption></figure>
  ```

### *2. 9A Raptor Integration Scenario Card*

<figure><img src="https://1567270722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbMdBZV3cNP56k0aYYCI6%2Fuploads%2Fgit-blob-ff9ec16d93d7cb66423acbe634fd78fc2005393f%2Fimage%20(62).png?alt=media" alt=""><figcaption></figcaption></figure>

For each entity, you can determine which tags/metadata a document receives

#### **General**

* Integration Scenario: choose the right scenario (this is hard coded)
* Enable: enable scenario
* Save Attachments to Raptor Side
* Use Specific Document Tags
* Document Template Code
  * You can choose from the list on raptor.9altitudes.com -> configuration -> templates
  * A template is a logical combination of multiple tags

#### Event Management

* FastTab available only for entities where you create documents
* Specifies when you want to generate/save documents to the document warehouse
* e.g. purchase order
*

```
<figure><img src="../../.gitbook/assets/image (143).png" alt=""><figcaption></figcaption></figure>
```

* The actions vary depending on the document and what actions you can take to make this document

#### Page Management

* Show actions on card/list page: specify if action 'View Raptor Documents' is visible (on card or list) (1)
* Show section on card/list page: specify if the 9A viewer is visible (on card or list) (2)

  * Show section on list page: you can also choose how you want to see the 9A viewer. You can turn the viewer off, make it visible as a section at the bottom or in the factbox at the right
  *

  ```
  <figure><img src="../../.gitbook/assets/image (63).png" alt=""><figcaption></figcaption></figure>
  ```
*

```
<figure><img src="../../.gitbook/assets/image (65).png" alt=""><figcaption></figcaption></figure>
```

* 9A viewer in the factbox:

  <figure><img src="https://1567270722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbMdBZV3cNP56k0aYYCI6%2Fuploads%2Fgit-blob-e6ab85dd5cd57686b5d6158086dc2d7081d12036%2Fimage%20(66).png?alt=media" alt=""><figcaption></figcaption></figure>

#### Integration API

* Entity Name: to which entity (from the 9A Raptor API Setup) do you link the scenario

#### Raptor Viewer Options

**Display & Layout Control**

Here you can choose how you want the viewer to display the information.

<figure><img src="https://1567270722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbMdBZV3cNP56k0aYYCI6%2Fuploads%2Fgit-blob-f449d8a4b40ef519e3ff802a6df33a2f4ee9508a%2Fimage%20(715).png?alt=media" alt=""><figcaption></figcaption></figure>

* Default: Standard view, preview pane is visible for details or viewing the document.
* Compact: Preview pane is initially hidden, showing only the document list. Once you click on the arrow at the right of the viewer, the preview pane becomes visible.
*

```
<figure><img src="../../.gitbook/assets/image (716).png" alt=""><figcaption></figcaption></figure>
```

**Advanced Control**

These fields are turned off and not visible by default. When you want to modify these options, you will have to add the fields through personalisation.

<figure><img src="https://1567270722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbMdBZV3cNP56k0aYYCI6%2Fuploads%2Fgit-blob-d4bb0625b776982794cfdba00808d96801094d47%2Fimage%20(728).png?alt=media" alt=""><figcaption></figcaption></figure>

*Button & Action Control*

| Control          | Effect                                                                |
| ---------------- | --------------------------------------------------------------------- |
| Disable Upload   | Hide the upload button to prevent users from uploading new documents. |
| Disable Download | Hide the download button to restrict document downloads.              |
| Disable View     | Hide the view button, which opens the preview in a new tab/window.    |
| Disable Email    | Hide the email button to prevent document email distribution.         |
| Disable Copy     | Hide the copy button to prevent document duplication.                 |
| Disable Delete   | Hide the delete button to protect documents from removal.             |

*Advanced Feature Control*

| Control                   | Effect                                                                            |
| ------------------------- | --------------------------------------------------------------------------------- |
| Disable Context Detach    | Prevent users from detaching documents from the current Business Central context. |
| Disable External Source   | Disable the ability to use external document sources.                             |
| Disable Document Triggers | Disable automatic document triggers in the viewer.                                |
| Disable Tenant Name       | Hide the tenant name display in the viewer.                                       |
| Disable Search bar        | Disable the search bar.                                                           |

*Security & Compliance*

* Readonly Mode: Enable full readonly mode, preventing all modifications to documents

#### Integration API Fields

* Which fields do you want to create tags from: link field Names with tags (that you set up in the 9A Raptor API Setup)
* Check the field 'Integrate with 9A Raptor'

## 9A Raptor Document Distribution Setup

Document Distribution Routes enable documents to be transferred/copied between entities, while preserving their history through tags.

More information on the functionality and the configuration can be found on the following page:

<https://docs.raptor.9altitudes.com/9a-document-management/~/revisions/EdcJ0dgsyt3pc3Pe8tih/integrations/d365-business-central/document-distribution-routes>


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.dynalogic.com/birds-document-warehouse-product-overview/d365-business-central/configuration-9a-raptor-pages.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
