HOWTO: Upgrading the Zetadocs Expenses Connector for Business Central and NAV on-premises

ZTN6025

This Zetadocs technical note applies to:

• Zetadocs Expenses On-Premises Extension
• Zetadocs Expenses Connector

Summary

This technote will detail the steps involved in upgrading to the latest version of the Zetadocs Extension and Connector for NAV/Business Central On-premise. You will need access to the server in which NAV/Business Central is installed, alongside the Extension and Connector for expenses.

Please note, users will not be able to export whilst this process is ongoing.

More information

By completing the steps below, you will be fully upgraded to the latest version of the Extension and Connector for Zetadocs Expenses for NAV/Business Central. By the end of this, you should be able to fully export and make use of the newest features.

For the Zetadocs Expenses Connector for Business Central (on-premises), follow these steps in the technote:

1. Upgrading the Connector Service
2. Upgrading the Extension for Business Central On-Premise

For the Zetadocs Expenses Connector for NAV, follow these steps in the technote:

1. Upgrading the Connector Service
2. Upgrading the NAV objects and Add-in DLL (Connector for NAV)

Upgrading the Zetadocs Expenses Connector Service

1. The first step required is to take a backup of the Zetadocs.Approval.Connector.Service.exe.config file which is the config file for the Expenses Connector.
   1. This is typically stored here: C:\Program Files (x86)\Zetadocs Expenses Connector
2. Download the latest version of the connector package (containing the extension and connector) from our website. This can be found here.
3. Unpack this on the server where the components are, once initialised you will be asked if you want to perform an upgrade of the connector service. Select ‘Yes’ and resume through the install wizard.
4. This will now have updated the connector service, at this point double check the service is running and that the version has been updated in Programs and Features.

Upgrading the Extension for Business Central On-Premise

Publishing the Extension app file

1. Ensure you locate the correct version of the [Zetadocs Expenses Extension] .app file for your version of Business Central from your product download (found in the Business Central Extensions folder).
2. Use the below script in Business Central Administration Shell (update the values in bold below to match your server instance and the Zetadocs Expenses Extension for your version of Business Central).
3. Publish-NavApp -serverInstance <INSTANCE NAME> -path 'Equisys_Zetadocs Expenses - Expense Management_<VERSION>_runtime.app' -skipVerification -packageType Extension.

Installing the Extension

1. Go to the Extension Management page in the Business Central web client.
2.  Select the existing Extension, and click on Uninstall. 
3. Now select “Zetadocs Expenses - Expense Management” and click on Install.
4. Click Next and select the relevant language.
5. Accept the terms and conditions and click on Install.

Testing

1. Now, once the extension is updated and the connector is updated and running, navigate to your expenses site and attempt to export a fully approved report, if you are seeing any failures at this point, please reach out to support with the error by emailing support@equisys.com.

Upgrading the NAV objects and Add-in DLL (Connector for NAV)
 

NAV 2013 and Later

Installing the Add-in Dll for object compilation

1. On the system where you will update the objects using the Microsoft Dynamics NAV Developer Environment, navigate to the RTC add-ins folder. This is typically found at
   1.  C:\Program Files (x86)\Microsoft Dynamics NAV\<NAV VERSION>\RoleTailored Client\Add-ins.
2. Locate the existing folder named "Zetadocs Expenses"
3. Copy the new Zetadocs.Approval.Integration.dll from your product download (in the NAV Server Components\Add-ins\Zetadocs Expenses folder) to this folder, replacing the old .dll.

Installing the Add-in Dll for runtime

1. On the system where your Microsoft Dynamics NAV Server service is installed, navigate to the service add-ins folder. This is typically found at
   1.  C:\Program Files\Microsoft Dynamics NAV\<NAV VERSION>\Service\Add-ins
2. Locate the existing folder "Zetadocs Expenses"
3. Copy the Zetadocs.Approval.Integration.dll from your product download (in the NAV Server Components\Add-ins\Zetadocs Expenses folder) to this folder, replacing the old .dll.
4. Now restart the Microsoft Dynamics Nav Service.

Importing the Objects

1. Start the NAV Development Environment and open the Object Designer.
2. Select File and then Import. Browse to the NAV Server Components folder in your product download:
   1. For NA (North America) database with NAV 2013, select the "Zetadocs Expenses Objects - NA (NAV 7.00+).fob" file.
   2. For NA (North America) database with NAV 2018 or later, select the "Zetadocs Expenses Objects - NA (NAV 11.00+).fob" file.
   3. For UK (United Kingdom) or GB (Great Britain) database with NAV 2013, select the "Zetadocs Expenses Objects - UK (NAV 7.00).fob" file
   4. For UK (United Kingdom) or GB (Great Britain) database with NAV 2018 or later, select the "Zetadocs Expenses Objects - GB (NAV 11.00+).fob" file

Note: You may need to recompile the newly imported NAV objects after import. To do this, apply a "Version" field filter on "ALL" objects of "ZDA*". Then select all objects and press F11.

NAV 2009 R2

Installing the Add-in Dll for object compilation

1. On the system where you will update the objects using the Microsoft Dynamics NAV Classic Client, navigate to the RTC add-ins folder. This is typically found at
   1. C:\Program Files (x86)\Microsoft Dynamics NAV\60\RoleTailored Client\Add-ins
2. Locate the existing folder "Zetadocs Expenses".
3. Copy the Zetadocs.Approval.Integration.dll from your product download (in the NAV Server Components\Add-ins\Zetadocs Expenses folder) to this folder, replacing the old .dll
4. Perform steps 1 to 3 for the add-ins folder for the Classic Client. This is typically found at
   1. C:\Program Files (x86)\Microsoft Dynamics NAV\60\Classic\Add-ins

Installing the Add-in Dll for runtime

1. On the system where your Microsoft Dynamics NAV Server service is installed, navigate to the service add-ins folder. This is typically found at
   1. C:\Program Files (x86)\Microsoft Dynamics NAV\60\Service\Add-ins
2. Locate the folder "Zetadocs Expenses".
3. Copy the Zetadocs.Approval.Integration.dll from your product download (in the NAV Server Components\Add-ins\Zetadocs Expenses folder) to this folder, replacing the old .dll
4. Now restart the Microsoft Dynamics Nav Business Web Services Service

Importing the Objects

1. Start the NAV Classic Client and open the Object Designer.
2. Select File and then Import. Browse to the NAV Server Components folder in your product download:
   1. For NA (North America) database with NAV 2009 R2, select the "Zetadocs Expenses Objects - NA (NAV 6.10).fob" file.
   2. For UK (United Kingdom) or GB (Great Britain) database with NAV 2009 R2, select the "Zetadocs Expenses Objects - UK (NAV 6.10).fob" file.

Note: You may need to recompile the newly imported NAV objects after import. To do this, apply a "Version" field filter on "ALL" objects of "ZDA*". Then select all objects and press F11.

Testing (for all supported NAV versions)

To test that these web services are published and available you can try and access them using a web browser by adding the link to the web service.

Ensure that SOAP services have been enabled for the NAV Service in the NAV Administration program (for NAV 2009 R2, the SOAP services are enabled once the 'Microsoft Dynamics Business Web Services' service is started). For the Expenses Codeunit this would take the form: http://<Server>:<WebServicePort>/<ServerInstance>/WS/<CompanyName>/CodeUnit/Expenses.

Example link: http://localhost:7047/DynamicsNAV/WS/CRONUS%20International%20Ltd/Codeunit/Expenses

If successful, you will be shown a page of XML data prefixed with the following message;- “This XML file does not appear to have any style information associated with it. The document tree is shown below…..”

If you don’t receive this message, please return to Opening the Web Services section.

At this point, if you are seeing the correct XML page, navigate to your expenses site and attempt to export a fully approved report, if you are seeing any failures at this point, please reach out to support with the error by emailing support@equisys.com.

References

Zetadocs Expenses Installation Guides

Last updated: 14^th June 2023 (MT/NT) 

Keywords: Zetadocs Expenses Extension Upgrade, Connector Service, On-Premise