TIBCO Scribe® Online Connector For Microsoft Dynamics 365 Business Central / NAV

The TIBCO Scribe® Online Connector for Microsoft Dynamics 365 Business Central / NAV allows you to streamline your business’s finance, manufacturing, sales, shipping, project management, services, and more by integrating Business Central with your other applications. This Connector supports both REST and OData endpoints for a variety of operations including, query, create, update, insert, update/insert, and delete.

This Connector supports both Microsoft Dynamics 365 Business Central / NAV and Microsoft Dynamics NAV. Microsoft Dynamics 365 Business Central / NAV functionality is a subset of Microsoft Dynamics NAV.

Use the TIBCO Scribe® Connector for Dynamics 365 Business Central / NAV to create source or target Connections in Integration or Migration Solutions using the Open Data Protocol (OData) standard.

Connector Specifications

This Connector supports OData services for Microsoft Dynamics NAV 2015, 2016, 2017, 2018, and Microsoft Dynamics 365 Business Central / NAV. To verify that this Connector works with the OData service your system uses, contact your Dynamics 365 Business Central / NAV administrator.

Note: Options and features identified in this document may vary depending on the version of the Dynamics 365 Business Central / NAV OData service you are using.

  Supported

Agent Types

On Premise X
Cloud X

Replication Services

Source  
Target  

Integration Services

Source X
Target X

Migration Services

Source X
Target X

Maps

Integration X
Request-Reply X
Message  

Note:  This Connector is available from the TIBCO Scribe® Online Marketplace. See Marketplace TIBCO Scribe® Certified Connectors for more information.

Supported Entities

The Dynamics 365 Business Central / NAV Connector supports any entities that you have exposed to the OData service in Dynamics 365 Business Central / NAV.

Supported Operations

Standard operations for Dynamics 365 Business Central / NAV entities include:

Update Operations

Special Operations

Supported special operations are based on the version of the OData service used. Operations include:

Setup Considerations

Selecting An Agent Type For Dynamics 365 Business Central / NAV

Refer to TIBCO Scribe® Online Agents for information on available Agent types and how to select the best Agent for your Solution.

Connecting To Dynamics 365 Business Central / NAV

Note: Best practice is to create Connections with credentials that limit permissions in the target system, following the principle of least privilege. Using Administrator level credentials in a Connection provides Administrator level access to the target system for TIBCO Scribe® Online users. Depending on the entities supported, a TIBCO Scribe® Online user could alter user accounts in the target system.

  1. Select More > Connections from the menu.
  2. From the Connections page select Add to open the Add a New Connection dialog.
  3. Select the Connector from the drop-down list in the Connection Type field, and then enter the following information for this Connection:
    • Name — This can be any meaningful name, up to 25 characters.
    • Alias — An alias for this Connection name. The alias is generated from the Connection name, and can be up to 25 characters. The Connection alias can include letters, numbers, and underscores. Spaces and special characters are not accepted. You can change the alias. For more information, see Connection Alias.
    • OData Service URL — The address of any acceptable URL where the Dynamics 365 Business Central / NAV OData service is located.
    • User — The name of the user who has rights to access Dynamics 365 Business Central / NAV OData, if your Dynamics 365 Business Central / NAV OData service requires authentication.
    • Password — The password, if your Dynamics NAV OData service requires authentication.

      Note: If you are connecting to Dynamics 365 Business Central, you must enter your Web Service Access Key in the Password field NOT your password.

    • Company Name — Name of the Dynamics 365 Business Central / NAV Company to access. This field is optional. If left blank, Dynamics 365 Business Central / NAV returns the default company.
  4. Select Test to ensure that the Agent can connect to your database. Be sure to test the Connection against all Agents that use this Connection. See Testing Connections.
  5. Select OK to save the Connection.

Metadata Notes

Naming

Connection metadata must have unique entity, relationship, and field names. If your Connection metadata has duplicate names, review the source system to determine if the duplicates can be renamed.

Endpoint Support

The Connector does not currently support the FunctionImport or ActionImport OData features.

Data Types

The Connector converts DateTime data types on the OData V3 protocol as follows:

Filter, Match Criteria, Or Lookup

The Dynamics 365 Business Central / NAV Connector supports the following operators, based on the operators supported by your Dynamics 365 Business Central / NAV OData service:

Retry Logic

When a timeout or an exception occurs or the API indicates that too many requests are being sent the Connector retries three times. Each time a retry fails, the time between retries increases by 12 seconds.

Dynamics 365 Business Central / NAV Connection As IS/MS Source

Consider the following when using the Dynamics 365 Business Central / NAV Connector as an Integration Solution or Migration Solution source.

Filtering

When a datetime is configured on the Query Block on the Block Properties Net Change Tab to query for new and updated records, that configuration is treated as an additional filter. The Net Change datetime filter is applied as an AND after any other filters specified on the Block Properties Filter Tab. TIBCO Scribe® Online builds a query combining both the Net Change filter and the filters on the Filter tab. See Net Change And Filters for an example.

Some Connectors for TIBCO Scribe® Online only support one filter. For those Connectors you can use either Net Change or one filter on the Filter tab, not both.

Note: The Net Change date is ignored when previewing data on the Preview tab. Filters on the Block Properties Filters tab are used to filter the data on the Preview tab.

Query Objects

Use Dynamics 365 Business Central / NAV Query Objects to access the results of a Dynamics 365 Business Central / NAV custom query and use those results in a TIBCO Scribe® Online Query. Expose Query Objects to the OData service within Dynamics 365 Business Central / NAV to make them accessible by TIBCO Scribe® Online.

Query Objects are available in metadata for both source and target operations, however, only source operations are supported. If you use a Query Object in a target operation, all records fail with the following error: An error occurred while processing this request.

Note: For on premise versions of Dynamics 365 Business Central / NAV, Query Objects may fail with an error similar to the following:

When writing a JSON response, a user model must be specified and the entity set and entity type must be passed to the ODataMessageWriter.CreateODataEntryWriter method or the ODataFeedAndEntrySerializationInfo must be set on the ODataEntry or ODataFeed that is being written.

Try querying a similar Page Object.

Relationships

Dynamics 365 Business Central / NAV Connection As IS/MS Target

Consider the following when using the Dynamics 365 Business Central / NAV Connector as an Integration Solution or Migration Solution target.

Batch Processing

Optimistic Concurrency

Conditional Success

When you Insert or Update a record, some services may indicate success, but return error information in the response. When this occurs, refer to your Dynamics 365 Business Central / NAV OData service documentation for further information, and review the record for accuracy.

For example, if a record is inserted without providing a required field, an OData service may return a successful status code but the response has error information stating that the field is required. The OData service has committed the record but it could be inaccurate and possibly unusable. In this case, the TIBCO Scribe® Online Solution execution yields a record error. The corresponding records in the actual application may still need values for the required fields.

Troubleshooting

Prior versions of the Dynamics 365 Business Central / NAV Connector supported relationships. If you have Solutions configured with relationships and you are seeing errors, refer to the Errors In Scribe Online Dynamics NAV Solutions With Relationships Knowledge Base article for additional information.

TIBCO Scribe® Online API Considerations

You must define a Connection Name and Connection Alias for each OData endpoint.

To create Connections with the TIBCO Scribe® Online API, the Dynamics 365 Business Central / NAV Connector requires the following information:

Connector Name

Microsoft Dynamics 365 Business Central/NAV

Connector ID

DD5C2188-316A-41FA-8415-A14C1CACD59E

TIBCO Scribe® Online Connection Properties

In addition, this Connector uses the Connection properties shown in the following table.

Note: Connection property names are case-sensitive.

Name Data Type Required Secured Usage

ServiceUrl

string

Yes

No

 

User

string

No

No

 

Password

string

No

Yes

 

AuthenticationType

string

Yes

No

None, Basic

CompanyID

string

No

No

 

License Agreement

The TIBCO Scribe® Online End User License Agreement for the Dynamics 365 Business Central / NAV Connector describes TIBCO and your legal obligations and requirements. TIBCO suggests that you read the End User License Agreement.

More Information

For additional information on this Connector, refer to the Knowledge Base and Discussions in the TIBCO Community.