Dynamics NAV Connection Details¶
Introduction¶
Connector Version
This documentation is based on version 21.0.8663 of the connector.
Important
We recommend using the Dynamics NAV v2 connector to connect to Dynamics NAV as it allows for additional configuration properties.
Get Started¶
Dynamics NAV Version Support
The connector supports read/write access to Dynamics NAV 2013+ through OData Web services. To access data through the API, you will need to publish the pages you want to work with as Web services: In the Web or Windows Dynamics NAV client, search for 'Web services.' To add a page to the list of the pages exposed, select the Object Type and Object Id.
Establish a Connection¶
Connect to Dynamics NAV¶
Before the connector can connect with Dynamics NAV, OData services need to be enabled on the server. Once OData services are enabled, the connector will be able to query any services that are published on the server.
In addition, specify a URL
to a valid Dynamics NAV server organization root (e.g. http://MyServer:7048) and a ServerInstance
(e.g. DynamicsNAV71). If there is not a Service Default Company for the server, set the Company
(e.g. 'CRONUS Canada, Inc.') as well.
In a multitenant installation, specify the tenant ID in Tenant
(e.g. 'Cronus1').
Authenticate to Dynamics NAV¶
To authenticate, set the User
and Password
properties to valid Dynamics NAV logon credentials or Windows user credentials. Select the appropriate authentication method in AuthScheme
.
Auth Schemes¶
The available authentication schemes are configured in IIS where Dynamics NAV is hosted. In IIS you can select to enable or disable Digest, Basic, Windows, or Anonymous authentication. Please consult with your Dynamics NAV admin to determine which authentication scheme is appropriate for you. Set AuthScheme
to one of the following:
- NEGOTIATE (default) - It is part of the Windows authentication, also known as Kerberos.
- BASIC - Basic authentication.
- DIGEST - Digest authentication.
- NTLM - Part of the Windows authentication.
- NONE - Anonymous authentication.
Important Notes¶
Configuration Files and Their Paths¶
- All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.
Advanced Features¶
This section details a selection of advanced features of the Dynamics NAV connector.
User Defined Views
The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
SSL Configuration
Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert
property under "Connection String Options" for more information.
Proxy
To configure the connector using private agent proxy settings, select the Use Proxy Settings
checkbox on the connection configuration screen.
User Defined Views¶
The Dynamics NAV connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:
- Create a JSON-formatted configuration file defining the views you want.
- DDL statements.
Define Views Using a Configuration File¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Customer WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
Schema for User Defined Views¶
User Defined Views are exposed in the UserViews
schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName
property.
Work with User Defined Views¶
For example, a SQL statement with a User Defined View called UserViews.RCustomers
only lists customers in Raleigh:
SELECT * FROM Customers WHERE City = 'Raleigh';
An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
SSL Configuration¶
Customize the SSL Configuration¶
By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert
property for the available formats to do so.
Data Model¶
The Dynamics NAV connector models Dynamics NAV entities in relational tables and stored procedures. The table definitions are dynamically obtained from the OData service you connect to.
Tables
Only Pages that are published as Web Services in Dynamics NAV will be available as tables. The Data Model shows the tables available in the demonstration database; the actual tables available will depend on your Dynamics NAV instance.
Stored Procedures
Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.
Tables¶
The connector models the data in Dynamics NAV into a list of tables that can be queried using standard SQL statements.
Generally, querying Dynamics NAV tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.
Dynamics NAV Connector Tables¶
Name | Description |
---|---|
Company | The DynamicsNAV table Company. |
Country | The DynamicsNAV table Country. |
Currency | The DynamicsNAV table Currency. |
Customer | The DynamicsNAV table Customer. |
GeneralProductPosting | The DynamicsNAV table GeneralProductPosting. |
PurchaseLines | The DynamicsNAV table PurchaseLines. |
PurchaseOrder | The DynamicsNAV table PurchaseOrder. |
PurchaseOrderPurchLines | The DynamicsNAV table PurchaseOrderPurchLines. |
PurchaseOrders | The DynamicsNAV table PurchaseOrders. |
ResourceCard | The DynamicsNAV table ResourceCard. |
SalesOrder | The DynamicsNAV table SalesOrder. |
Company¶
The DynamicsNAV table Company.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
Name [KEY] | String | False | The Name column for the table Company. |
LinkedCountry | String | False | The LinkedCountry column for the table Company. |
LinkedCurrency | String | False | The LinkedCurrency column for the table Company. |
LinkedCustomer | String | False | The LinkedCustomer column for the table Company. |
LinkedGeneralProductPosting | String | False | The LinkedGeneralProductPosting column for the table Company. |
LinkedPurchaseLines | String | False | The LinkedPurchaseLines column for the table Company. |
LinkedPurchaseOrder | String | False | The LinkedPurchaseOrder column for the table Company. |
LinkedPurchaseOrderPurchLines | String | False | The LinkedPurchaseOrderPurchLines column for the table Company. |
LinkedPurchaseOrders | String | False | The LinkedPurchaseOrders column for the table Company. |
LinkedResourceCard | String | False | The LinkedResourceCard column for the table Company. |
LinkedSalesOrder | String | False | The LinkedSalesOrder column for the table Company. |
Country¶
The DynamicsNAV table Country.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
Code [KEY] | String | False | The Code column for the table Country. |
Address_Format | String | False | The Address_Format column for the table Country. |
Contact_Address_Format | String | False | The Contact_Address_Format column for the table Country. |
ETag | String | False | The ETag column for the table Country. |
EU_Country_Region_Code | String | False | The EU_Country_Region_Code column for the table Country. |
Intrastat_Code | String | False | The Intrastat_Code column for the table Country. |
Name | String | False | The Name column for the table Country. |
Currency¶
The DynamicsNAV table Currency.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
Code [KEY] | String | False | The Code column for the table Currency. |
Amount_Decimal_Places | String | False | The Amount_Decimal_Places column for the table Currency. |
Amount_Rounding_Precision | Decimal | False | The Amount_Rounding_Precision column for the table Currency. |
Appln_Rounding_Precision | Decimal | False | The Appln_Rounding_Precision column for the table Currency. |
Conv_LCY_Rndg_Credit_Acc | String | False | The Conv_LCY_Rndg_Credit_Acc column for the table Currency. |
Conv_LCY_Rndg_Debit_Acc | String | False | The Conv_LCY_Rndg_Debit_Acc column for the table Currency. |
CurrencyFactor | Decimal | False | The CurrencyFactor column for the table Currency. |
Description | String | False | The Description column for the table Currency. |
EMU_Currency | Boolean | False | The EMU_Currency column for the table Currency. |
ETag | String | False | The ETag column for the table Currency. |
Invoice_Rounding_Precision | Decimal | False | The Invoice_Rounding_Precision column for the table Currency. |
Invoice_Rounding_Type | String | False | The Invoice_Rounding_Type column for the table Currency. |
Last_Date_Adjusted | Datetime | False | The Last_Date_Adjusted column for the table Currency. |
Last_Date_Modified | Datetime | False | The Last_Date_Modified column for the table Currency. |
Max_Payment_Tolerance_Amount | Decimal | False | The Max_Payment_Tolerance_Amount column for the table Currency. |
Max_VAT_Difference_Allowed | Decimal | False | The Max_VAT_Difference_Allowed column for the table Currency. |
Payment_Tolerance_Percent | Decimal | False | The Payment_Tolerance_Percent column for the table Currency. |
Realized_G_L_Gains_Account | String | False | The Realized_G_L_Gains_Account column for the table Currency. |
Realized_G_L_Losses_Account | String | False | The Realized_G_L_Losses_Account column for the table Currency. |
Realized_Gains_Acc | String | False | The Realized_Gains_Acc column for the table Currency. |
Realized_Losses_Acc | String | False | The Realized_Losses_Acc column for the table Currency. |
Residual_Gains_Account | String | False | The Residual_Gains_Account column for the table Currency. |
Residual_Losses_Account | String | False | The Residual_Losses_Account column for the table Currency. |
Symbol | String | False | The Symbol column for the table Currency. |
Unit_Amount_Decimal_Places | String | False | The Unit_Amount_Decimal_Places column for the table Currency. |
Unit_Amount_Rounding_Precision | Decimal | False | The Unit_Amount_Rounding_Precision column for the table Currency. |
Unrealized_Gains_Acc | String | False | The Unrealized_Gains_Acc column for the table Currency. |
Unrealized_Losses_Acc | String | False | The Unrealized_Losses_Acc column for the table Currency. |
VAT_Rounding_Type | String | False | The VAT_Rounding_Type column for the table Currency. |
Customer¶
The DynamicsNAV table Customer.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
No [KEY] | String | False | The No column for the table Customer. |
Address | String | False | The Address column for the table Customer. |
Address_2 | String | False | The Address_2 column for the table Customer. |
Allow_Line_Disc | Boolean | False | The Allow_Line_Disc column for the table Customer. |
Application_Method | String | False | The Application_Method column for the table Customer. |
Balance_LCY | Decimal | False | The Balance_LCY column for the table Customer. |
Bank_Communication | String | False | The Bank_Communication column for the table Customer. |
Base_Calendar_Code | String | False | The Base_Calendar_Code column for the table Customer. |
Bill_to_Customer_No | String | False | The Bill_to_Customer_No column for the table Customer. |
Block_Payment_Tolerance | Boolean | False | The Block_Payment_Tolerance column for the table Customer. |
Blocked | String | False | The Blocked column for the table Customer. |
Cash_Flow_Payment_Terms_Code | String | False | The Cash_Flow_Payment_Terms_Code column for the table Customer. |
Check_Date_Format | String | False | The Check_Date_Format column for the table Customer. |
Check_Date_Separator | String | False | The Check_Date_Separator column for the table Customer. |
City | String | False | The City column for the table Customer. |
Combine_Shipments | Boolean | False | The Combine_Shipments column for the table Customer. |
Contact | String | False | The Contact column for the table Customer. |
Copy_Sell_to_Addr_to_Qte_From | String | False | The Copy_Sell_to_Addr_to_Qte_From column for the table Customer. |
Country_Region_Code | String | False | The Country_Region_Code column for the table Customer. |
County | String | False | The County column for the table Customer. |
Credit_Limit_LCY | Decimal | False | The Credit_Limit_LCY column for the table Customer. |
CURP_No | String | False | The CURP_No column for the table Customer. |
Currency_Code | String | False | The Currency_Code column for the table Customer. |
Currency_Filter | String | False | The Currency_Filter column for the table Customer. |
Customer_Disc_Group | String | False | The Customer_Disc_Group column for the table Customer. |
Customer_Posting_Group | String | False | The Customer_Posting_Group column for the table Customer. |
Customer_Price_Group | String | False | The Customer_Price_Group column for the table Customer. |
Customized_Calendar | String | False | The Customized_Calendar column for the table Customer. |
E_Mail | String | False | The E_Mail column for the table Customer. |
ETag | String | False | The ETag column for the table Customer. |
Fax_No | String | False | The Fax_No column for the table Customer. |
Fin_Charge_Terms_Code | String | False | The Fin_Charge_Terms_Code column for the table Customer. |
Gen_Bus_Posting_Group | String | False | The Gen_Bus_Posting_Group column for the table Customer. |
Global_Dimension_1_Filter | String | False | The Global_Dimension_1_Filter column for the table Customer. |
Global_Dimension_2_Filter | String | False | The Global_Dimension_2_Filter column for the table Customer. |
Home_Page | String | False | The Home_Page column for the table Customer. |
IC_Partner_Code | String | False | The IC_Partner_Code column for the table Customer. |
Invoice_Copies | Int32 | False | The Invoice_Copies column for the table Customer. |
Invoice_Disc_Code | String | False | The Invoice_Disc_Code column for the table Customer. |
Language_Code | String | False | The Language_Code column for the table Customer. |
Last_Date_Modified | Datetime | False | The Last_Date_Modified column for the table Customer. |
Last_Statement_No | Int32 | False | The Last_Statement_No column for the table Customer. |
Location_Code | String | False | The Location_Code column for the table Customer. |
Name | String | False | The Name column for the table Customer. |
Partner_Type | String | False | The Partner_Type column for the table Customer. |
Payment_Method_Code | String | False | The Payment_Method_Code column for the table Customer. |
Payment_Terms_Code | String | False | The Payment_Terms_Code column for the table Customer. |
Phone_No | String | False | The Phone_No column for the table Customer. |
Post_Code | String | False | The Post_Code column for the table Customer. |
Preferred_Bank_Account | String | False | The Preferred_Bank_Account column for the table Customer. |
Prepayment_Percent | Decimal | False | The Prepayment_Percent column for the table Customer. |
Prices_Including_VAT | Boolean | False | The Prices_Including_VAT column for the table Customer. |
Primary_Contact_No | String | False | The Primary_Contact_No column for the table Customer. |
Print_Statements | Boolean | False | The Print_Statements column for the table Customer. |
Reminder_Terms_Code | String | False | The Reminder_Terms_Code column for the table Customer. |
Reserve | String | False | The Reserve column for the table Customer. |
Responsibility_Center | String | False | The Responsibility_Center column for the table Customer. |
RFC_No | String | False | The RFC_No column for the table Customer. |
Salesperson_Code | String | False | The Salesperson_Code column for the table Customer. |
Search_Name | String | False | The Search_Name column for the table Customer. |
Service_Zone_Code | String | False | The Service_Zone_Code column for the table Customer. |
Shipment_Method_Code | String | False | The Shipment_Method_Code column for the table Customer. |
Shipping_Advice | String | False | The Shipping_Advice column for the table Customer. |
Shipping_Agent_Code | String | False | The Shipping_Agent_Code column for the table Customer. |
Shipping_Agent_Service_Code | String | False | The Shipping_Agent_Service_Code column for the table Customer. |
Shipping_Time | String | False | The Shipping_Time column for the table Customer. |
State_Inscription | String | False | The State_Inscription column for the table Customer. |
Tax_Area_Code | String | False | The Tax_Area_Code column for the table Customer. |
Tax_Exemption_No | String | False | The Tax_Exemption_No column for the table Customer. |
Tax_Identification_Type | String | False | The Tax_Identification_Type column for the table Customer. |
Tax_Liable | Boolean | False | The Tax_Liable column for the table Customer. |
VAT_Bus_Posting_Group | String | False | The VAT_Bus_Posting_Group column for the table Customer. |
VAT_Registration_No | String | False | The VAT_Registration_No column for the table Customer. |
LinkedCountry_Region_Code_Link | String | False | The LinkedCountry_Region_Code_Link column for the table Customer. |
LinkedCurrency_Code_Link | String | False | The LinkedCurrency_Code_Link column for the table Customer. |
LinkedCurrency_Filter_Link | String | False | The LinkedCurrency_Filter_Link column for the table Customer. |
GeneralProductPosting¶
The DynamicsNAV table GeneralProductPosting.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
Code [KEY] | String | False | The Code column for the table GeneralProductPosting. |
Auto_Insert_Default | Boolean | False | The Auto_Insert_Default column for the table GeneralProductPosting. |
Def_VAT_Prod_Posting_Group | String | False | The Def_VAT_Prod_Posting_Group column for the table GeneralProductPosting. |
Description | String | False | The Description column for the table GeneralProductPosting. |
ETag | String | False | The ETag column for the table GeneralProductPosting. |
PurchaseLines¶
The DynamicsNAV table PurchaseLines.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
Document_No [KEY] | String | False | The Document_No column for the table PurchaseLines. |
Document_Type [KEY] | String | False | The Document_Type column for the table PurchaseLines. |
Line_No [KEY] | Int32 | False | The Line_No column for the table PurchaseLines. |
Amt_Rcd_Not_Invoiced_LCY | Decimal | False | The Amt_Rcd_Not_Invoiced_LCY column for the table PurchaseLines. |
Buy_from_Vendor_No | String | False | The Buy_from_Vendor_No column for the table PurchaseLines. |
Description | String | False | The Description column for the table PurchaseLines. |
Direct_Unit_Cost | Decimal | False | The Direct_Unit_Cost column for the table PurchaseLines. |
ETag | String | False | The ETag column for the table PurchaseLines. |
Expected_Receipt_Date | Datetime | False | The Expected_Receipt_Date column for the table PurchaseLines. |
Indirect_Cost_Percent | Decimal | False | The Indirect_Cost_Percent column for the table PurchaseLines. |
Job_Line_Type | String | False | The Job_Line_Type column for the table PurchaseLines. |
Job_No | String | False | The Job_No column for the table PurchaseLines. |
Job_Task_No | String | False | The Job_Task_No column for the table PurchaseLines. |
Line_Amount | Decimal | False | The Line_Amount column for the table PurchaseLines. |
Location_Code | String | False | The Location_Code column for the table PurchaseLines. |
No | String | False | The No column for the table PurchaseLines. |
Outstanding_Amount_LCY | Decimal | False | The Outstanding_Amount_LCY column for the table PurchaseLines. |
Outstanding_Quantity | Decimal | False | The Outstanding_Quantity column for the table PurchaseLines. |
Quantity | Decimal | False | The Quantity column for the table PurchaseLines. |
Reserved_Qty_Base | Decimal | False | The Reserved_Qty_Base column for the table PurchaseLines. |
Shortcut_Dimension_1_Code | String | False | The Shortcut_Dimension_1_Code column for the table PurchaseLines. |
Shortcut_Dimension_2_Code | String | False | The Shortcut_Dimension_2_Code column for the table PurchaseLines. |
ShortcutDimCode_x005B_3_x005D\_ | String | False | The ShortcutDimCode_x005B_3_x005D_ column for the table PurchaseLines. |
ShortcutDimCode_x005B_4_x005D\_ | String | False | The ShortcutDimCode_x005B_4_x005D_ column for the table PurchaseLines. |
ShortcutDimCode_x005B_5_x005D\_ | String | False | The ShortcutDimCode_x005B_5_x005D_ column for the table PurchaseLines. |
ShortcutDimCode_x005B_6_x005D\_ | String | False | The ShortcutDimCode_x005B_6_x005D_ column for the table PurchaseLines. |
ShortcutDimCode_x005B_7_x005D\_ | String | False | The ShortcutDimCode_x005B_7_x005D_ column for the table PurchaseLines. |
ShortcutDimCode_x005B_8_x005D\_ | String | False | The ShortcutDimCode_x005B_8_x005D_ column for the table PurchaseLines. |
Type | String | False | The Type column for the table PurchaseLines. |
Unit_Cost_LCY | Decimal | False | The Unit_Cost_LCY column for the table PurchaseLines. |
Unit_of_Measure_Code | String | False | The Unit_of_Measure_Code column for the table PurchaseLines. |
Unit_Price_LCY | Decimal | False | The Unit_Price_LCY column for the table PurchaseLines. |
Variant_Code | String | False | The Variant_Code column for the table PurchaseLines. |
PurchaseOrder¶
The DynamicsNAV table PurchaseOrder.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
Document_Type [KEY] | String | False | The Document_Type column for the table PurchaseOrder. |
No [KEY] | String | False | The No column for the table PurchaseOrder. |
Area | String | False | The Area column for the table PurchaseOrder. |
Assigned_User_ID | String | False | The Assigned_User_ID column for the table PurchaseOrder. |
Buy_from_Address | String | False | The Buy_from_Address column for the table PurchaseOrder. |
Buy_from_Address_2 | String | False | The Buy_from_Address_2 column for the table PurchaseOrder. |
Buy_from_City | String | False | The Buy_from_City column for the table PurchaseOrder. |
Buy_from_Contact | String | False | The Buy_from_Contact column for the table PurchaseOrder. |
Buy_from_Contact_No | String | False | The Buy_from_Contact_No column for the table PurchaseOrder. |
Buy_from_County | String | False | The Buy_from_County column for the table PurchaseOrder. |
Buy_from_Post_Code | String | False | The Buy_from_Post_Code column for the table PurchaseOrder. |
Buy_from_Vendor_Name | String | False | The Buy_from_Vendor_Name column for the table PurchaseOrder. |
Buy_from_Vendor_No | String | False | The Buy_from_Vendor_No column for the table PurchaseOrder. |
Compress_Prepayment | Boolean | False | The Compress_Prepayment column for the table PurchaseOrder. |
Creditor_No | String | False | The Creditor_No column for the table PurchaseOrder. |
Currency_Code | String | False | The Currency_Code column for the table PurchaseOrder. |
Document_Date | Datetime | False | The Document_Date column for the table PurchaseOrder. |
Due_Date | Datetime | False | The Due_Date column for the table PurchaseOrder. |
Entry_Point | String | False | The Entry_Point column for the table PurchaseOrder. |
ETag | String | False | The ETag column for the table PurchaseOrder. |
Expected_Receipt_Date | Datetime | False | The Expected_Receipt_Date column for the table PurchaseOrder. |
Inbound_Whse_Handling_Time | String | False | The Inbound_Whse_Handling_Time column for the table PurchaseOrder. |
IRS_1099_Code | String | False | The IRS_1099_Code column for the table PurchaseOrder. |
Job_Queue_Status | String | False | The Job_Queue_Status column for the table PurchaseOrder. |
Lead_Time_Calculation | String | False | The Lead_Time_Calculation column for the table PurchaseOrder. |
Location_Code | String | False | The Location_Code column for the table PurchaseOrder. |
No_of_Archived_Versions | Int32 | False | The No_of_Archived_Versions column for the table PurchaseOrder. |
On_Hold | String | False | The On_Hold column for the table PurchaseOrder. |
Order_Address_Code | String | False | The Order_Address_Code column for the table PurchaseOrder. |
Order_Date | Datetime | False | The Order_Date column for the table PurchaseOrder. |
Pay_to_Address | String | False | The Pay_to_Address column for the table PurchaseOrder. |
Pay_to_Address_2 | String | False | The Pay_to_Address_2 column for the table PurchaseOrder. |
Pay_to_City | String | False | The Pay_to_City column for the table PurchaseOrder. |
Pay_to_Contact | String | False | The Pay_to_Contact column for the table PurchaseOrder. |
Pay_to_Contact_No | String | False | The Pay_to_Contact_No column for the table PurchaseOrder. |
Pay_to_County | String | False | The Pay_to_County column for the table PurchaseOrder. |
Pay_to_Name | String | False | The Pay_to_Name column for the table PurchaseOrder. |
Pay_to_Post_Code | String | False | The Pay_to_Post_Code column for the table PurchaseOrder. |
Pay_to_Vendor_No | String | False | The Pay_to_Vendor_No column for the table PurchaseOrder. |
Payment_Discount_Percent | Decimal | False | The Payment_Discount_Percent column for the table PurchaseOrder. |
Payment_Reference | String | False | The Payment_Reference column for the table PurchaseOrder. |
Payment_Terms_Code | String | False | The Payment_Terms_Code column for the table PurchaseOrder. |
Pmt_Discount_Date | Datetime | False | The Pmt_Discount_Date column for the table PurchaseOrder. |
Posting_Date | Datetime | False | The Posting_Date column for the table PurchaseOrder. |
Posting_Description | String | False | The Posting_Description column for the table PurchaseOrder. |
Prepayment_Due_Date | Datetime | False | The Prepayment_Due_Date column for the table PurchaseOrder. |
Prepayment_Percent | Decimal | False | The Prepayment_Percent column for the table PurchaseOrder. |
Prepmt_Include_Tax | Boolean | False | The Prepmt_Include_Tax column for the table PurchaseOrder. |
Prepmt_Payment_Discount_Percent | Decimal | False | The Prepmt_Payment_Discount_Percent column for the table PurchaseOrder. |
Prepmt_Payment_Terms_Code | String | False | The Prepmt_Payment_Terms_Code column for the table PurchaseOrder. |
Prepmt_Pmt_Discount_Date | Datetime | False | The Prepmt_Pmt_Discount_Date column for the table PurchaseOrder. |
Promised_Receipt_Date | Datetime | False | The Promised_Receipt_Date column for the table PurchaseOrder. |
Provincial_Tax_Area_Code | String | False | The Provincial_Tax_Area_Code column for the table PurchaseOrder. |
Purchaser_Code | String | False | The Purchaser_Code column for the table PurchaseOrder. |
Quote_No | String | False | The Quote_No column for the table PurchaseOrder. |
Requested_Receipt_Date | Datetime | False | The Requested_Receipt_Date column for the table PurchaseOrder. |
Responsibility_Center | String | False | The Responsibility_Center column for the table PurchaseOrder. |
Sell_to_Customer_No | String | False | The Sell_to_Customer_No column for the table PurchaseOrder. |
Ship_to_Address | String | False | The Ship_to_Address column for the table PurchaseOrder. |
Ship_to_Address_2 | String | False | The Ship_to_Address_2 column for the table PurchaseOrder. |
Ship_to_City | String | False | The Ship_to_City column for the table PurchaseOrder. |
Ship_to_Code | String | False | The Ship_to_Code column for the table PurchaseOrder. |
Ship_to_Contact | String | False | The Ship_to_Contact column for the table PurchaseOrder. |
Ship_to_County | String | False | The Ship_to_County column for the table PurchaseOrder. |
Ship_to_Name | String | False | The Ship_to_Name column for the table PurchaseOrder. |
Ship_to_Post_Code | String | False | The Ship_to_Post_Code column for the table PurchaseOrder. |
Ship_to_UPS_Zone | String | False | The Ship_to_UPS_Zone column for the table PurchaseOrder. |
Shipment_Method_Code | String | False | The Shipment_Method_Code column for the table PurchaseOrder. |
Shortcut_Dimension_1_Code | String | False | The Shortcut_Dimension_1_Code column for the table PurchaseOrder. |
Shortcut_Dimension_2_Code | String | False | The Shortcut_Dimension_2_Code column for the table PurchaseOrder. |
Status | String | False | The Status column for the table PurchaseOrder. |
Tax_Area_Code | String | False | The Tax_Area_Code column for the table PurchaseOrder. |
Tax_Exemption_No | String | False | The Tax_Exemption_No column for the table PurchaseOrder. |
Tax_Liable | Boolean | False | The Tax_Liable column for the table PurchaseOrder. |
Transaction_Specification | String | False | The Transaction_Specification column for the table PurchaseOrder. |
Transaction_Type | String | False | The Transaction_Type column for the table PurchaseOrder. |
Transport_Method | String | False | The Transport_Method column for the table PurchaseOrder. |
Vendor_Cr_Memo_No | String | False | The Vendor_Cr_Memo_No column for the table PurchaseOrder. |
Vendor_Invoice_No | String | False | The Vendor_Invoice_No column for the table PurchaseOrder. |
Vendor_Order_No | String | False | The Vendor_Order_No column for the table PurchaseOrder. |
Vendor_Shipment_No | String | False | The Vendor_Shipment_No column for the table PurchaseOrder. |
LinkedPurchaseOrderPurchLines | String | False | The LinkedPurchaseOrderPurchLines column for the table PurchaseOrder. |
LinkedCurrency_Code_Link | String | False | The LinkedCurrency_Code_Link column for the table PurchaseOrder. |
PurchaseOrderPurchLines¶
The DynamicsNAV table PurchaseOrderPurchLines.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
Document_No [KEY] | String | False | The Document_No column for the table PurchaseOrderPurchLines. |
Document_Type [KEY] | String | False | The Document_Type column for the table PurchaseOrderPurchLines. |
Line_No [KEY] | Int32 | False | The Line_No column for the table PurchaseOrderPurchLines. |
Allow_Invoice_Disc | Boolean | False | The Allow_Invoice_Disc column for the table PurchaseOrderPurchLines. |
Allow_Item_Charge_Assignment | Boolean | False | The Allow_Item_Charge_Assignment column for the table PurchaseOrderPurchLines. |
Appl_to_Item_Entry | Int32 | False | The Appl_to_Item_Entry column for the table PurchaseOrderPurchLines. |
Bin_Code | String | False | The Bin_Code column for the table PurchaseOrderPurchLines. |
Blanket_Order_Line_No | Int32 | False | The Blanket_Order_Line_No column for the table PurchaseOrderPurchLines. |
Blanket_Order_No | String | False | The Blanket_Order_No column for the table PurchaseOrderPurchLines. |
Cross_Reference_No | String | False | The Cross_Reference_No column for the table PurchaseOrderPurchLines. |
Description | String | False | The Description column for the table PurchaseOrderPurchLines. |
Direct_Unit_Cost | Decimal | False | The Direct_Unit_Cost column for the table PurchaseOrderPurchLines. |
Drop_Shipment | Boolean | False | The Drop_Shipment column for the table PurchaseOrderPurchLines. |
ETag | String | False | The ETag column for the table PurchaseOrderPurchLines. |
Expected_Receipt_Date | Datetime | False | The Expected_Receipt_Date column for the table PurchaseOrderPurchLines. |
Finished | Boolean | False | The Finished column for the table PurchaseOrderPurchLines. |
GST_HST | String | False | The GST_HST column for the table PurchaseOrderPurchLines. |
IC_Partner_Code | String | False | The IC_Partner_Code column for the table PurchaseOrderPurchLines. |
IC_Partner_Ref_Type | String | False | The IC_Partner_Ref_Type column for the table PurchaseOrderPurchLines. |
IC_Partner_Reference | String | False | The IC_Partner_Reference column for the table PurchaseOrderPurchLines. |
Inbound_Whse_Handling_Time | String | False | The Inbound_Whse_Handling_Time column for the table PurchaseOrderPurchLines. |
Indirect_Cost_Percent | Decimal | False | The Indirect_Cost_Percent column for the table PurchaseOrderPurchLines. |
Inv_Discount_Amount | Decimal | False | The Inv_Discount_Amount column for the table PurchaseOrderPurchLines. |
IRS_1099_Liable | Boolean | False | The IRS_1099_Liable column for the table PurchaseOrderPurchLines. |
Job_Line_Amount | Decimal | False | The Job_Line_Amount column for the table PurchaseOrderPurchLines. |
Job_Line_Amount_LCY | Decimal | False | The Job_Line_Amount_LCY column for the table PurchaseOrderPurchLines. |
Job_Line_Disc_Amount_LCY | Decimal | False | The Job_Line_Disc_Amount_LCY column for the table PurchaseOrderPurchLines. |
Job_Line_Discount_Amount | Decimal | False | The Job_Line_Discount_Amount column for the table PurchaseOrderPurchLines. |
Job_Line_Discount_Percent | Decimal | False | The Job_Line_Discount_Percent column for the table PurchaseOrderPurchLines. |
Job_Line_Type | String | False | The Job_Line_Type column for the table PurchaseOrderPurchLines. |
Job_No | String | False | The Job_No column for the table PurchaseOrderPurchLines. |
Job_Planning_Line_No | Int32 | False | The Job_Planning_Line_No column for the table PurchaseOrderPurchLines. |
Job_Remaining_Qty | Decimal | False | The Job_Remaining_Qty column for the table PurchaseOrderPurchLines. |
Job_Task_No | String | False | The Job_Task_No column for the table PurchaseOrderPurchLines. |
Job_Total_Price | Decimal | False | The Job_Total_Price column for the table PurchaseOrderPurchLines. |
Job_Total_Price_LCY | Decimal | False | The Job_Total_Price_LCY column for the table PurchaseOrderPurchLines. |
Job_Unit_Price | Decimal | False | The Job_Unit_Price column for the table PurchaseOrderPurchLines. |
Job_Unit_Price_LCY | Decimal | False | The Job_Unit_Price_LCY column for the table PurchaseOrderPurchLines. |
Lead_Time_Calculation | String | False | The Lead_Time_Calculation column for the table PurchaseOrderPurchLines. |
Line_Amount | Decimal | False | The Line_Amount column for the table PurchaseOrderPurchLines. |
Line_Discount_Amount | Decimal | False | The Line_Discount_Amount column for the table PurchaseOrderPurchLines. |
Line_Discount_Percent | Decimal | False | The Line_Discount_Percent column for the table PurchaseOrderPurchLines. |
Location_Code | String | False | The Location_Code column for the table PurchaseOrderPurchLines. |
No | String | False | The No column for the table PurchaseOrderPurchLines. |
Nonstock | Boolean | False | The Nonstock column for the table PurchaseOrderPurchLines. |
Operation_No | String | False | The Operation_No column for the table PurchaseOrderPurchLines. |
Order_Date | Datetime | False | The Order_Date column for the table PurchaseOrderPurchLines. |
Planned_Receipt_Date | Datetime | False | The Planned_Receipt_Date column for the table PurchaseOrderPurchLines. |
Planning_Flexibility | String | False | The Planning_Flexibility column for the table PurchaseOrderPurchLines. |
Prepayment_Percent | Decimal | False | The Prepayment_Percent column for the table PurchaseOrderPurchLines. |
Prepmt_Amt_Deducted | Decimal | False | The Prepmt_Amt_Deducted column for the table PurchaseOrderPurchLines. |
Prepmt_Amt_Inv | Decimal | False | The Prepmt_Amt_Inv column for the table PurchaseOrderPurchLines. |
Prepmt_Amt_to_Deduct | Decimal | False | The Prepmt_Amt_to_Deduct column for the table PurchaseOrderPurchLines. |
Prepmt_Line_Amount | Decimal | False | The Prepmt_Line_Amount column for the table PurchaseOrderPurchLines. |
Prod_Order_Line_No | Int32 | False | The Prod_Order_Line_No column for the table PurchaseOrderPurchLines. |
Prod_Order_No | String | False | The Prod_Order_No column for the table PurchaseOrderPurchLines. |
Promised_Receipt_Date | Datetime | False | The Promised_Receipt_Date column for the table PurchaseOrderPurchLines. |
Provincial_Tax_Area_Code | String | False | The Provincial_Tax_Area_Code column for the table PurchaseOrderPurchLines. |
Qty_Assigned | Decimal | False | The Qty_Assigned column for the table PurchaseOrderPurchLines. |
Qty_to_Assign | Decimal | False | The Qty_to_Assign column for the table PurchaseOrderPurchLines. |
Qty_to_Invoice | Decimal | False | The Qty_to_Invoice column for the table PurchaseOrderPurchLines. |
Qty_to_Receive | Decimal | False | The Qty_to_Receive column for the table PurchaseOrderPurchLines. |
Quantity | Decimal | False | The Quantity column for the table PurchaseOrderPurchLines. |
Quantity_Invoiced | Decimal | False | The Quantity_Invoiced column for the table PurchaseOrderPurchLines. |
Quantity_Received | Decimal | False | The Quantity_Received column for the table PurchaseOrderPurchLines. |
Requested_Receipt_Date | Datetime | False | The Requested_Receipt_Date column for the table PurchaseOrderPurchLines. |
Reserved_Quantity | Decimal | False | The Reserved_Quantity column for the table PurchaseOrderPurchLines. |
Return_Reason_Code | String | False | The Return_Reason_Code column for the table PurchaseOrderPurchLines. |
Shortcut_Dimension_1_Code | String | False | The Shortcut_Dimension_1_Code column for the table PurchaseOrderPurchLines. |
Shortcut_Dimension_2_Code | String | False | The Shortcut_Dimension_2_Code column for the table PurchaseOrderPurchLines. |
ShortcutDimCode_x005B_3_x005D\_ | String | False | The ShortcutDimCode_x005B_3_x005D_ column for the table PurchaseOrderPurchLines. |
ShortcutDimCode_x005B_4_x005D\_ | String | False | The ShortcutDimCode_x005B_4_x005D_ column for the table PurchaseOrderPurchLines. |
ShortcutDimCode_x005B_5_x005D\_ | String | False | The ShortcutDimCode_x005B_5_x005D_ column for the table PurchaseOrderPurchLines. |
ShortcutDimCode_x005B_6_x005D\_ | String | False | The ShortcutDimCode_x005B_6_x005D_ column for the table PurchaseOrderPurchLines. |
ShortcutDimCode_x005B_7_x005D\_ | String | False | The ShortcutDimCode_x005B_7_x005D_ column for the table PurchaseOrderPurchLines. |
ShortcutDimCode_x005B_8_x005D\_ | String | False | The ShortcutDimCode_x005B_8_x005D_ column for the table PurchaseOrderPurchLines. |
Tax_Area_Code | String | False | The Tax_Area_Code column for the table PurchaseOrderPurchLines. |
Tax_Group_Code | String | False | The Tax_Group_Code column for the table PurchaseOrderPurchLines. |
Tax_Liable | Boolean | False | The Tax_Liable column for the table PurchaseOrderPurchLines. |
Type | String | False | The Type column for the table PurchaseOrderPurchLines. |
Unit_Cost_LCY | Decimal | False | The Unit_Cost_LCY column for the table PurchaseOrderPurchLines. |
Unit_of_Measure | String | False | The Unit_of_Measure column for the table PurchaseOrderPurchLines. |
Unit_of_Measure_Code | String | False | The Unit_of_Measure_Code column for the table PurchaseOrderPurchLines. |
Unit_Price_LCY | Decimal | False | The Unit_Price_LCY column for the table PurchaseOrderPurchLines. |
Use_Tax | Boolean | False | The Use_Tax column for the table PurchaseOrderPurchLines. |
Variant_Code | String | False | The Variant_Code column for the table PurchaseOrderPurchLines. |
VAT_Prod_Posting_Group | String | False | The VAT_Prod_Posting_Group column for the table PurchaseOrderPurchLines. |
Whse_Outstanding_Qty_Base | Decimal | False | The Whse_Outstanding_Qty_Base column for the table PurchaseOrderPurchLines. |
Work_Center_No | String | False | The Work_Center_No column for the table PurchaseOrderPurchLines. |
LinkedBlanket_Order_Line_No_Link | String | False | The LinkedBlanket_Order_Line_No_Link column for the table PurchaseOrderPurchLines. |
PurchaseOrders¶
The DynamicsNAV table PurchaseOrders.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
Document_No [KEY] | String | False | The Document_No column for the table PurchaseOrders. |
Document_Type [KEY] | String | False | The Document_Type column for the table PurchaseOrders. |
Line_No [KEY] | Int32 | False | The Line_No column for the table PurchaseOrders. |
Amount | Decimal | False | The Amount column for the table PurchaseOrders. |
Buy_from_Vendor_No | String | False | The Buy_from_Vendor_No column for the table PurchaseOrders. |
Currency_Code | String | False | The Currency_Code column for the table PurchaseOrders. |
Description | String | False | The Description column for the table PurchaseOrders. |
Direct_Unit_Cost | Decimal | False | The Direct_Unit_Cost column for the table PurchaseOrders. |
ETag | String | False | The ETag column for the table PurchaseOrders. |
Expected_Receipt_Date | Datetime | False | The Expected_Receipt_Date column for the table PurchaseOrders. |
Line_Discount_Percent | Decimal | False | The Line_Discount_Percent column for the table PurchaseOrders. |
No | String | False | The No column for the table PurchaseOrders. |
Outstanding_Quantity | Decimal | False | The Outstanding_Quantity column for the table PurchaseOrders. |
Quantity | Decimal | False | The Quantity column for the table PurchaseOrders. |
Type | String | False | The Type column for the table PurchaseOrders. |
Unit_of_Measure_Code | String | False | The Unit_of_Measure_Code column for the table PurchaseOrders. |
LinkedCurrency_Code_Link | String | False | The LinkedCurrency_Code_Link column for the table PurchaseOrders. |
ResourceCard¶
The DynamicsNAV table ResourceCard.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
No [KEY] | String | False | The No column for the table ResourceCard. |
Address | String | False | The Address column for the table ResourceCard. |
Address_2 | String | False | The Address_2 column for the table ResourceCard. |
Automatic_Ext_Texts | Boolean | False | The Automatic_Ext_Texts column for the table ResourceCard. |
Base_Unit_of_Measure | String | False | The Base_Unit_of_Measure column for the table ResourceCard. |
Blocked | Boolean | False | The Blocked column for the table ResourceCard. |
City | String | False | The City column for the table ResourceCard. |
Contract_Class | String | False | The Contract_Class column for the table ResourceCard. |
County | String | False | The County column for the table ResourceCard. |
Direct_Unit_Cost | Decimal | False | The Direct_Unit_Cost column for the table ResourceCard. |
Education | String | False | The Education column for the table ResourceCard. |
Employment_Date | Datetime | False | The Employment_Date column for the table ResourceCard. |
ETag | String | False | The ETag column for the table ResourceCard. |
Gen_Prod_Posting_Group | String | False | The Gen_Prod_Posting_Group column for the table ResourceCard. |
IC_Partner_Purch_G_L_Acc_No | String | False | The IC_Partner_Purch_G_L_Acc_No column for the table ResourceCard. |
Indirect_Cost_Percent | Decimal | False | The Indirect_Cost_Percent column for the table ResourceCard. |
Job_Title | String | False | The Job_Title column for the table ResourceCard. |
Last_Date_Modified | Datetime | False | The Last_Date_Modified column for the table ResourceCard. |
Name | String | False | The Name column for the table ResourceCard. |
Post_Code | String | False | The Post_Code column for the table ResourceCard. |
Price_Profit_Calculation | String | False | The Price_Profit_Calculation column for the table ResourceCard. |
Profit_Percent | Decimal | False | The Profit_Percent column for the table ResourceCard. |
Resource_Group_No | String | False | The Resource_Group_No column for the table ResourceCard. |
Search_Name | String | False | The Search_Name column for the table ResourceCard. |
Social_Security_No | String | False | The Social_Security_No column for the table ResourceCard. |
Tax_Group_Code | String | False | The Tax_Group_Code column for the table ResourceCard. |
Time_Sheet_Approver_User_ID | String | False | The Time_Sheet_Approver_User_ID column for the table ResourceCard. |
Time_Sheet_Owner_User_ID | String | False | The Time_Sheet_Owner_User_ID column for the table ResourceCard. |
Type | String | False | The Type column for the table ResourceCard. |
Unit_Cost | Decimal | False | The Unit_Cost column for the table ResourceCard. |
Unit_Price | Decimal | False | The Unit_Price column for the table ResourceCard. |
Use_Time_Sheet | Boolean | False | The Use_Time_Sheet column for the table ResourceCard. |
VAT_Prod_Posting_Group | String | False | The VAT_Prod_Posting_Group column for the table ResourceCard. |
LinkedGen_Prod_Posting_Group_Link | String | False | The LinkedGen_Prod_Posting_Group_Link column for the table ResourceCard. |
SalesOrder¶
The DynamicsNAV table SalesOrder.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
Document_No [KEY] | String | False | The Document_No column for the table SalesOrder. |
Document_Type [KEY] | String | False | The Document_Type column for the table SalesOrder. |
Line_No [KEY] | Int32 | False | The Line_No column for the table SalesOrder. |
Amount | Decimal | False | The Amount column for the table SalesOrder. |
Currency_Code | String | False | The Currency_Code column for the table SalesOrder. |
Description | String | False | The Description column for the table SalesOrder. |
ETag | String | False | The ETag column for the table SalesOrder. |
Line_Discount_Percent | Decimal | False | The Line_Discount_Percent column for the table SalesOrder. |
No | String | False | The No column for the table SalesOrder. |
Outstanding_Quantity | Decimal | False | The Outstanding_Quantity column for the table SalesOrder. |
Quantity | Decimal | False | The Quantity column for the table SalesOrder. |
Sell_to_Customer_No | String | False | The Sell_to_Customer_No column for the table SalesOrder. |
Shipment_Date | Datetime | False | The Shipment_Date column for the table SalesOrder. |
Type | String | False | The Type column for the table SalesOrder. |
Unit_of_Measure_Code | String | False | The Unit_of_Measure_Code column for the table SalesOrder. |
Unit_Price | Decimal | False | The Unit_Price column for the table SalesOrder. |
Work_Type_Code | String | False | The Work_Type_Code column for the table SalesOrder. |
LinkedCurrency_Code_Link | String | False | The LinkedCurrency_Code_Link column for the table SalesOrder. |
Stored Procedures¶
Stored procedures are available to complement the data available from the Data Model. It may be necessary to update data available from a view using a stored procedure because the data does not provide for direct, table-like, two-way updates. In these situations, the retrieval of the data is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures take a list of parameters and return back a dataset that contains the collection of tuples that constitute the response.
Dynamics NAV Connector Stored Procedures¶
Name | Description |
---|---|
CreateAssociation | Creates an association between two entities. This will only work for tables that have in-line columns. |
ListAssociations | Lists associations for a given entity Id. This will only work for tables that have in-line columns. |
RemoveAssociation | Removes an association between two entities. This will only work for tables that have in-line columns. |
CreateAssociation¶
Creates an association between two entities. This will only work for tables that have in-line columns.
Input¶
Name | Type | Description |
---|---|---|
SourceId | String | The ID of the entity you are listing associations for. |
DestinationId | String | The ID of the entity you are associating with the SourceId. |
SourceTable | String | The table where the SourceId is listed. For example, if the SourceId was from a table called Customers, enter Customers. |
DestinationTable | String | The table where the DestinationId is listed. For example, if the DestinationId comes from a table called Orders, enter Orders. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
\* | String | Output will vary for each entity. |
ListAssociations¶
Lists associations for a given entity Id. This will only work for tables that have in-line columns.
Input¶
Name | Type | Description |
---|---|---|
SourceId | String | The ID of the entity you are listing associations for. |
SourceTable | String | The table where the entity comes from that you are listing entities for. For example, if the SourceId was from a table called Customers, set this parameter to Customers. |
DestinationTable | String | The table you are looking for associations with. For example, if you are looking for associations with the Orders table, set this parameter to Orders. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
\* | String | Output will vary for each entity. |
RemoveAssociation¶
Removes an association between two entities. This will only work for tables that have in-line columns.
Input¶
Name | Type | Description |
---|---|---|
SourceId | String | The ID of the entity you are removing an association from. |
DestinationId | String | The ID of the entity you are removing as an association. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
\* | String | Output will vary for each entity. |
System Tables¶
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
Schema Tables¶
The following tables return database metadata for Dynamics NAV:
- sys_catalogs: Lists the available databases.
- sys_schemas: Lists the available schemas.
- sys_tables: Lists the available tables and views.
- sys_tablecolumns: Describes the columns of the available tables and views.
- sys_procedures: Describes the available stored procedures.
- sys_procedureparameters: Describes stored procedure parameters.
- sys_keycolumns: Describes the primary and foreign keys.
- sys_indexes: Describes the available indexes.
Data Source Tables¶
The following tables return information about how to connect to and query the data source:
- sys_connection_props: Returns information on the available connection properties.
- sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.
Query Information Tables¶
The following table returns query statistics for data modification queries:
- sys_identity: Returns information about batch operations or single updates.
sys_catalogs¶
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
sys_schemas¶
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
sys_tables¶
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view. |
TableType | String | The table type (table or view). |
Description | String | A description of the table or view. |
IsUpdateable | Boolean | Whether the table can be updated. |
sys_tablecolumns¶
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Customer table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Customer'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view containing the column. |
ColumnName | String | The column name. |
DataTypeName | String | The data type name. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The storage size of the column. |
DisplaySize | Int32 | The designated column's normal maximum width in characters. |
NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
IsNullable | Boolean | Whether the column can contain null. |
Description | String | A brief description of the column. |
Ordinal | Int32 | The sequence number of the column. |
IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
IsGeneratedColumn | String | Whether the column is generated. |
IsHidden | Boolean | Whether the column is hidden. |
IsArray | Boolean | Whether the column is an array. |
sys_procedures¶
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database containing the stored procedure. |
SchemaName | String | The schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure. |
Description | String | A description of the stored procedure. |
ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
sys_procedureparameters¶
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the CreateAssociation stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='CreateAssociation' AND Direction=1 OR Direction=2
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the stored procedure. |
SchemaName | String | The name of the schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure containing the parameter. |
ColumnName | String | The name of the stored procedure parameter. |
Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
IsNullable | Boolean | Whether the parameter can contain null. |
IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
IsArray | Boolean | Whether the parameter is an array. |
Description | String | The description of the parameter. |
Ordinal | Int32 | The index of the parameter. |
sys_keycolumns¶
Describes the primary and foreign keys.
The following query retrieves the primary key for the Customer table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Customer'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
sys_foreignkeys¶
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
sys_indexes¶
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the index. |
SchemaName | String | The name of the schema containing the index. |
TableName | String | The name of the table containing the index. |
IndexName | String | The index name. |
ColumnName | String | The name of the column associated with the index. |
IsUnique | Boolean | True if the index is unique. False otherwise. |
IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder | String | The sort order: A for ascending or D for descending. |
OrdinalPosition | Int16 | The sequence number of the column in the index. |
sys_connection_props¶
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:dynamicsnav:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Columns¶
Name | Type | Description |
---|---|---|
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
sys_sqlinfo¶
Describes the SELECT query processing that the connector can offload to the data source.
Collaborative Query Processing¶
When working with data sources that do not support SQL-92, you can query the sys_sqlinfo view to determine the query capabilities of the underlying APIs, expressed in SQL syntax. The connector offloads as much of the SELECT statement processing as possible to the server and then processes the rest of the query in memory.
Discovering the Data Source's SELECT Capabilities¶
Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the connector can offload to the data source or process client side. Your data source may support additional SQL syntax. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
---|---|---|
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG , COUNT , MAX , MIN , SUM , DISTINCT |
COUNT | Whether COUNT function is supported. | YES , NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | = , > , < , >= , <= , <> , != , LIKE , NOT LIKE , IN , NOT IN , IS NULL , IS NOT NULL , AND , OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO , NO_RELATION , EQUALS_SELECT , SQL_GB_COLLATE |
STRING_FUNCTIONS | Supported string functions. | LENGTH , CHAR , LOCATE , REPLACE , SUBSTRING , RTRIM , LTRIM , RIGHT , LEFT , UCASE , SPACE , SOUNDEX , LCASE , CONCAT , ASCII , REPEAT , OCTET , BIT , POSITION , INSERT , TRIM , UPPER , REGEXP , LOWER , DIFFERENCE , CHARACTER , SUBSTR , STR , REVERSE , PLAN , UUIDTOSTR , TRANSLATE , TRAILING , TO , STUFF , STRTOUUID , STRING , SPLIT , SORTKEY , SIMILAR , REPLICATE , PATINDEX , LPAD , LEN , LEADING , KEY , INSTR , INSERTSTR , HTML , GRAPHICAL , CONVERT , COLLATION , CHARINDEX , BYTE |
NUMERIC_FUNCTIONS | Supported numeric functions. | ABS , ACOS , ASIN , ATAN , ATAN2 , CEILING , COS , COT , EXP , FLOOR , LOG , MOD , SIGN , SIN , SQRT , TAN , PI , RAND , DEGREES , LOG10 , POWER , RADIANS , ROUND , TRUNCATE |
TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW , CURDATE , DAYOFMONTH , DAYOFWEEK , DAYOFYEAR , MONTH , QUARTER , WEEK , YEAR , CURTIME , HOUR , MINUTE , SECOND , TIMESTAMPADD , TIMESTAMPDIFF , DAYNAME , MONTHNAME , CURRENT_DATE , CURRENT_TIME , CURRENT_TIMESTAMP , EXTRACT |
REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES , NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES , NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES , NO |
DATASYNCVERSION | The Data Sync version needed to access this driver. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | The Data Sync category of this driver. | Source , Destination , Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE , FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES , NO |
SQL_CAP | All supported SQL capabilities for this driver. | SELECT , INSERT , DELETE , UPDATE , TRANSACTIONS , ORDERBY , OAUTH , ASSIGNEDID , LIMIT , LIKE , BULKINSERT , COUNT , BULKDELETE , BULKUPDATE , GROUPBY , HAVING , AGGS , OFFSET , REPLICATE , COUNTDISTINCT , JOINS , DROP , CREATE , DISTINCT , INNERJOINS , SUBQUERIES , ALTER , MULTIPLESCHEMAS , GROUPBYNORELATION , OUTERJOINS , UNIONALL , UNION , UPSERT , GETDELETED , CROSSJOINS , GROUPBYCOLLATE , MULTIPLECATS , FULLOUTERJOIN , MERGE , JSONEXTRACT , BULKUPSERT , SUM , SUBQUERIESFULL , MIN , MAX , JOINSFULL , XMLEXTRACT , AVG , MULTISTATEMENTS , FOREIGNKEYS , CASE , LEFTJOINS , COMMAJOINS , WITH , LITERALS , RENAME , NESTEDTABLES , EXECUTE , BATCH , BASIC , INDEX |
PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES , NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE , FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE , FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Columns¶
Name | Type | Description |
---|---|---|
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
sys_identity¶
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Columns¶
Name | Type | Description |
---|---|---|
Id | String | The database-generated ID returned from a data modification operation. |
Batch | String | An identifier for the batch. 1 for a single operation. |
Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message | String | SUCCESS or an error message if the update in the batch failed. |
Data Type Mapping¶
Data Type Mappings¶
The connector maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.
Dynamics NAV (OData V4) | Schema |
---|---|
Edm.Binary | binary |
Edm.Boolean | bool |
Edm.Date | datetime |
Edm.DateTimeOffset | datetime |
Edm.Decimal | decimal |
Edm.Double | double |
Edm.Guid | guid |
Edm.Int32 | int |
Edm.String | string |
Edm.TimeOfDay | time |
Advanced Configurations Properties¶
The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.
Property | Description |
---|---|
URL | URL to the Dynamics NAV server organization root. For example, http://MyServer:7048 . |
ServerInstance | The instance of the Dynamics NAV server. For example, DynamicsNAV71. |
AuthScheme | The scheme used for authentication. Accepted entries are NTLM, Basic, Digest, None, or Negotiate. Negotiate is the default option. |
User | The Dynamics NAV user account used to authenticate. |
Company | The company to submit queries against. For example, 'CRONUS Canada, Inc.'. |
Password | The password used to authenticate the user. |
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Property | Description |
---|---|
ContinueOnError | Whether or not to continue after encountering an error on a batch request. |
MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
Other | These hidden properties are used only in specific use cases. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Tenant | Use this value to connect to a specific Tenant in a multitenant installation of DynamicsNAV. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
Authentication¶
This section provides a complete list of authentication properties you can configure.
Property | Description |
---|---|
URL | URL to the Dynamics NAV server organization root. For example, http://MyServer:7048 . |
ServerInstance | The instance of the Dynamics NAV server. For example, DynamicsNAV71. |
AuthScheme | The scheme used for authentication. Accepted entries are NTLM, Basic, Digest, None, or Negotiate. Negotiate is the default option. |
User | The Dynamics NAV user account used to authenticate. |
Company | The company to submit queries against. For example, 'CRONUS Canada, Inc.'. |
Password | The password used to authenticate the user. |
URL¶
URL to the Dynamics NAV server organization root. For example, http://MyServer:7048
.
Data Type¶
string
Default Value¶
""
Remarks¶
URL to the Dynamics NAV server organization root. For example, http://MyServer:7048
.
ServerInstance¶
The instance of the Dynamics NAV server. For example, DynamicsNAV71.
Data Type¶
string
Default Value¶
""
Remarks¶
The instance of the Dynamics NAV server. For example, DynamicsNAV71.
AuthScheme¶
The scheme used for authentication. Accepted entries are NTLM, Basic, Digest, None, or Negotiate. Negotiate is the default option.
Possible Values¶
None
, NTLM
, Basic
, Digest
, Negotiate
Data Type¶
string
Default Value¶
Negotiate
Remarks¶
Together with Password and User, this field is used to authenticate against the server. Negotiate is the default option. Use the following options to select your authentication scheme:
- NTLM: Set this to use your Windows credentials to authenticate.
- Basic: Set this to use HTTP Basic authentication.
- Negotiate: If
AuthScheme
is set to Negotiate, the connector will negotiate an authentication mechanism with the server. SetAuthScheme
to Negotiate to use Kerberos authentication. - Digest: Set this to use HTTP Digest authentication.
- None: Indicates the service does not use authentication. I is not normally supported.
User¶
The Dynamics NAV user account used to authenticate.
Data Type¶
string
Default Value¶
""
Remarks¶
Together with Password, this field is used to authenticate against the Dynamics NAV server.
Company¶
The company to submit queries against. For example, 'CRONUS Canada, Inc.'.
Data Type¶
string
Default Value¶
""
Remarks¶
The company to submit queries against. For example, 'CRONUS Canada, Inc.'. This property is required if the Service Default Company has not been specified for the ServerInstance in question. If blank, the connector will submit queries to the server and attempt to use the Service Default Company.
Password¶
The password used to authenticate the user.
Data Type¶
string
Default Value¶
""
Remarks¶
The User and Password
are together used to authenticate with the server.
SSL¶
This section provides a complete list of SSL properties you can configure.
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
SSLServerCert¶
The certificate to be accepted from the server when connecting using TLS/SSL.
Data Type¶
string
Default Value¶
""
Remarks¶
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
---|---|
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
Schema¶
This section provides a complete list of schema properties you can configure.
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Location¶
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type¶
string
Default Value¶
%APPDATA%\DynamicsNAV Data Provider\Schema
Remarks¶
The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location
property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\DynamicsNAV Data Provider\Schema" with %APPDATA%
being set to the user's configuration directory:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
BrowsableSchemas¶
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
Tables¶
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Views¶
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Miscellaneous¶
This section provides a complete list of miscellaneous properties you can configure.
Property | Description |
---|---|
ContinueOnError | Whether or not to continue after encountering an error on a batch request. |
MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
Other | These hidden properties are used only in specific use cases. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Tenant | Use this value to connect to a specific Tenant in a multitenant installation of DynamicsNAV. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
ContinueOnError¶
Whether or not to continue after encountering an error on a batch request.
Data Type¶
bool
Default Value¶
false
Remarks¶
This connection property is only supported on servers with OData version 4.0 and higher. However, individual servers may choose to ignore this setting. Setting ContinueOnError to true will cause exceptions to be returned in the temporary table instead of being thrown when a batch request is attempted.
MaxRows¶
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Data Type¶
int
Default Value¶
-1
Remarks¶
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other¶
These hidden properties are used only in specific use cases.
Data Type¶
string
Default Value¶
""
Remarks¶
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
Integration and Formatting¶
Property | Description |
---|---|
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
PseudoColumns¶
This property indicates whether or not to include pseudo columns as columns to the table.
Data Type¶
string
Default Value¶
""
Remarks¶
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
Tenant¶
Use this value to connect to a specific Tenant in a multitenant installation of DynamicsNAV.
Data Type¶
string
Default Value¶
""
Remarks¶
Specify the tenant ID to connect to a specific tenant in a multitenant installation of DynamicsNAV. For example, "Cronus1".
Timeout¶
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type¶
int
Default Value¶
60
Remarks¶
If Timeout
= 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout
expires and the operation is not yet complete, the connector throws an exception.