Installing for On-Premise

Attention

The installation instructions on this page are for installing Document Creator in an on-premise Dynamics NAV or Dynamics 365 Business Central environment. If you are looking for installation instructions for Dynamics 365 Business Central online (SaaS/Cloud), then please follow the steps on the page Installing the Extension.

PrerequisitesLink

Before installing Document Creator in your Dynamics 365 Business Central or NAV environment, please make sure the prerequisites listed in this section are met. Please note that there is a "Demo" version (for evaluation purposes) and a "Release" version (for production environments) of Document Creator, which each have their own prerequisites. Downloads for both versions can be found on the Downloads page on our website.

For additional support, please visit our Support page to get in contact with our support engineers.

Demo VersionLink

Before installing the "Demo" version, please check if the following prerequisites are met:

  • The Business Central license should have access to the 70000..70020 and 71000..71010 object ID range.
  • The latest available Demo product key should be used, which can be downloaded from the Downloads page on our website together with the Demo version.
  • For the use of the Document Creator Report Templates, the Business Central license should have access to the 72100..72199 (W1) or 72200..72299 (NA) object ID range. However, please note that the source code of the report templates is also available.
  • For a demo of all the possibilities of the Document Creator Designer, please check out the Document Creator Designer Demo. The Designer Demo can be downloaded from the Downloads page on our website as well.

Release VersionLink

Before installing the "Release" version, please check if the following prerequisites are met:

  • The Business Central/NAV license should have access to the Document Creator object ID range (i.e., 11249650..). If you encounter any issues with missing permissions, please ensure you have downloaded a new Business Central/NAV license and that you have restarted your server instance(s) after uploading your license to the database.
  • A product key registered for your Business Central/NAV license's Serial No./VOICE ID/PSBCID should be used.
  • For installation and activation instructions of the Document Creator stand-alone Designer for Dynamics 365 Business Central, please consult the Installing the Designer documentation page.

Supported VersionsLink

With the latest Document Creator release the following minimum target versions are officially supported:

Folder Dynamics NAV/BC Version
NAV80W1 2015: W1 8.00 Build 38457 (Cumulative Update 1)
NAV90W1 2016: W1 9.00 Build 42815
NAV100W1 2017: W1 10.0 Build 13682
NAV110W1 2018: W1 11.0 Build 19394
NAV130W1 BC13: W1 13.0 Build 24623 (Fall '18)
NAV140W1 BC14: W1 14.3 Build 34444 (Spring '19, Cumulative Update 2)
NAV150W1 BC15: W1 15.0 Build 36510 ('19 release Wave 2)
NAV160W1 BC16: W1 16.2 Build 13779 ('20 release Wave 1)

InstallationLink

This document describes the installation procedure for the following NAV/BC target versions:

Dynamics 365 Business Central 2019 release Wave 2 and upLink

The installation files are grouped into a directory for each target version (e.g., NAV150W1 corresponds to Dynamics 365 Business Central 2019 release Wave 2). Make sure to use the files from the directory that matches your target. The installation set for each target version contains the following directories:

Folder Contents
DOCUMENT CREATOR The Document Creator extension/app.
TEMPLATE Files for template reports, layouts and translations.
  • The Document Creator app contains all the features available for both On-Premise and SaaS installations, i.e., creating/editing/importing/exporting/archiving layouts, export profiles, etc.

  • The Document Creator On-Premise app is an extension on the Document Creator app which makes the add-on use an on-premise installation of the report engine. It also includes the features that are only available on-premise, e.g., the RDLC layout converter.

  • The template report objects are provided with a Document Creator W1 Templates extension. You can use the source code of the report objects from this extension as a starting point for your own reports.

To install Document Creator, please follow these steps:

  1. Publishing the "Document Creator" extension

    Open the Business Central Administration Shell (as admin) and run the following command to publish the new extension to your database:

    Publish-NAVApp -ServerInstance $ServerInstance -Path "...\DOCUMENT CREATOR\Apportunix_Document Creator_$version.app"
    

    (With $version being the version of the app you are going to install and $ServerInstance being the name of the target BC server instance.)

  2. Installing the "Document Creator" extension

    If you are not upgrading from a previous version of the extension, see 2.A.

    If you are upgrading from a previous version of the extension, see 2.B.

    A. Install the extension either through the Install action on the Extension Management page, or run the following command(s):

    Sync-NAVApp -ServerInstance $ServerInstance -Name "Document Creator"
    Install-NAVApp -ServerInstance $ServerInstance -Name "Document Creator"
    

    B. At this point you will have two versions published to the database. In the Extension Management page you will see the old version is Installed, while the new version is only Published/Not installed.

    Please, first uninstall the Document Creator On-Premise app.

    Run the following commands to sync the app and start the data upgrade:

    Sync-NAVApp -ServerInstance $ServerInstance -Name "Document Creator" -Version $version
    Start-NAVAppDataUpgrade -ServerInstance $ServerInstance -Name "Document Creator" -Version $version
    

    At this point, you will still have two versions of the extension published, but now the new version is installed and the old version only published.

  3. Publishing and Installing the "Document Creator On-Premise" extension

    Please, follow the same instructions from step (1) and (2) to publish and install the Document Creator On-Premise app.

  4. Installing the Control Add-In

    Open the client, search for, and open the Document Creator Setup page.

    In the Document Creator Setup page:

    a. Invoke the Install Add-in action.

    Install BC Add-In (1)

    b. Read and agree with the license agreement and enter your e-mail.

    Install BC Add-In (2)

    c. You will get a message if the installation has completed successfully.

    Attention

    "Allow HTTP Client Requests" should be enabled for the Document Creator On-Premise app for this action to work. You can change this setting on the Extension Management page via the Configure action.

  5. Setting up your Product Key

    To set up your product key, open the Document Creator Setup page:

    a. Paste the product key in the "Product Key" field.

    b. Invoke the Check Product Key action to validate the product key.

    c. Invoke the License Information action for more information about the license.

    Info

    If the BC Serial No. of your BC license and the Document Creator product key do not match, then a warning will be displayed which informs you that the currently active and licensed BC license are not matching. If this message is shown, you can use Document Creator without any problems, but a watermark will be shown on generated reports.

  6. Installing the Templates

    Please follow the installation instructions on the Templates page.

Document Creator is ready for use!

Dynamics 365 Business Central Spring '19 ReleaseLink

The installation files can be found in the NAV140W1 directory, which corresponds to the Dynamics 365 Business Central Spring '19 Release. The installation set contains the following directories:

Folder Contents
DOCUMENT CREATOR The Document Creator extension/app.
DOCUMENT CREATOR UTILS The Document Creator Utilities extension/app + C/AL version.
TEMPLATE Files for template reports, layouts and translations.
  • The core features of Document Creator are included in the "Document Creator" extension, i.e., creating/editing/importing/exporting/archiving/converting layouts, export profiles, etc.

  • The translation features and report utility functions that can be used in report objects are provided within a separate "Document Creator Utilities" extension. A C/AL version of the objects from this extension are available as well, which you may prefer if you still want to be able to use these features in C/AL report objects again as well.

  • The template report objects are provided with a "Document Creator W1 Templates" extension. You can use the source code of the report objects from this extension as a starting point for your own reports. A C/AL version of the template report objects are available as well.

To install Document Creator, please follow these steps:

  1. Publishing the "Document Creator" extension

    Open the Business Central Administration Shell (as admin) and run the following command to publish the new extension to your database:

    Publish-NAVApp -ServerInstance $ServerInstance -Path "...\DOCUMENT CREATOR\Apportunix_Document Creator_$version.app"
    

    (With $version being the version of the app you are going to install and $ServerInstance being the name of the target BC server instance.)

  2. Installing the "Document Creator" extension

    If you are not upgrading from a previous version of the extension, see 2.A. If you are upgrading from a previous version of the extension, see 2.B.

    A. Install the extension either through the Install action on the Extension Management page, or run the following command(s):

    Sync-NAVApp -ServerInstance $ServerInstance -Name "Document Creator"
    Install-NAVApp -ServerInstance $ServerInstance -Name "Document Creator"
    

    B. At this point you will have two versions published to the database. In the Extension Management page you will see the old version is Installed, while the new version is only Published/Not installed.

    Run the following commands to sync the app and start the data upgrade:

    Sync-NAVApp -ServerInstance $ServerInstance -Name "Document Creator" -Version $version
    Start-NAVAppDataUpgrade -ServerInstance $ServerInstance -Name "Document Creator" -Version $version
    

    At this point, you will still have two versions of the extension published, but now the new version is installed and the old version only published.

  3. Publishing and Installing the "Document Creator Utilities" extension

    If you want to use translation features and report utility functions from AL only, see 3.A. If you want to use translation features and report utility functions also from C/AL, see 3.B.

    A. Open the Business Central Administration Shell (as admin) and run the following command to publish the extension to your database:

    Publish-NAVApp -ServerInstance $ServerInstance -Path "...\DOCUMENT CREATOR\Apportunix_Document Creator Utilities_$version.app"
    

    Then, install the extension either through the Install action on the Extension Management page, or run the following commands:

    Sync-NAVApp -ServerInstance $ServerInstance -Name "Document Creator Utilities"
    Install-NAVApp -ServerInstance $ServerInstance -Name "Document Creator Utilities"
    

    If you are upgrading from a previous version of the extension, follow the instructions as described in the previous step to run the data upgrade in the same way for this extension.

    B. Start the Dynamics NAV development environment and import the NAV<version>_NewObjects.fob file.

    Import the menu-suite from the NAV<version>_MenuSuite1056.fob file or edit the menu-suite object ID in the NAV<version>_MenuSuite1056.txt file.

  4. Installing the Control Add-In

    Open the client, the first time you will get this message:

    Install BC14 Add-In (1)

    Choose "Yes"; Read and agree with the license agreement and enter your e-mail.

    Install BC14 Add-In (2)

    You will see a message once the installation has completed successfully.

  5. Setting up your Product Key

    To set up your product key, open the Document Creator Setup page:

    a. Paste the product key in the "Product Key" field.

    b. Invoke the Check Product Key action to validate the product key.

    c. Invoke the License Information action for more information about the license.

  6. Installing the W1 Template Reports

    If you want to use the AL version of the W1 template reports, see 6.A. If you want to use the C/AL version of the W1 template reports, see 6.B.

    A. First publish and then install the extension from the following file:

    Apportunix_Document Creator W1 Templates_<version>.app
    

    Then, search for and open the Custom Report Layouts page, choose 'Import Report Package' and import the following file:

    LayoutPackage - W1  DCR_<Release/Demo>_<version>.dcr
    

    B. Search for and open the Custom Report Layouts page in the Windows client, choose 'Import Report Package' and import the following file:

    ReportPackage - W1  DCR_<Release/Demo>_<version>.dcr
    

    Then, compile the Document Creator objects (filter on versionlist @*DCR*).

  7. Importing the Template Translations

    Search for and open the Configuration Packages page (RapidStart):

    a. Choose Import Package and select the RapidStart package from the TEMPLATE directory.

    b. Select the imported DCR package, choose Apply Package, then confirm. This imports a set of default translations for the Document Creator layouts.

Document Creator is ready for use!

Dynamics NAV 2015 – 2018 and Dynamics 365 Business Central Fall '18 ReleaseLink

The installation files are grouped into a directory for each target version (e.g., NAV80W1 corresponds to Dynamics NAV 2015). Make sure to use the files from the directory that matches your target. The installation set for each target version contains the following directories:

Folder Contents
APPLICATION OBJECTS New and Merge NAV Objects.
TEMPLATE Files for template reports, layouts and translations.

To install Document Creator, please follow these steps:

  1. Start the Dynamics NAV development environment and import the NAV<version> - New Objects.fob file.
  2. Merge the following NAV objects with the objects in file NAV<version> - Merge Objects.txt:

    Type ID Name Applicable for NAV Version
    Codeunit 40 LogInManagement NAV2015
    Table 9650 Custom Report Layout NAV2015 / NAV2016 / NAV2017 / NAV2018 / BC13
    Codeunit 9651 Document Report Mgt. NAV2015 / NAV2016 / NAV2017 / NAV2018
  3. Import the menu-suite from the NAV<version> - MenuSuite - 1056.fob file or edit the menu-suite object ID in the NAV<version> - MenuSuite - 1056.txt file.

  4. Compile the merged objects.
  5. Open the Windows Client, the first time you will get this message:

    Install NAV Add-In (1)

    Choose "Yes"; Read and agree with the license agreement and enter your e-mail.

    Install NAV Add-In (2)

    You will see a message once the installation has completed successfully.

  6. Navigate to (or search for) 'Departments | Document Creator | Document Creator Setup':

    a. Paste the product key in the "Product Key" field.

    b. Choose Check Product key to validate the "Product Key".

    c. Choose License Information for more information about the license.

  7. Navigate to (or search for) 'Departments | Document Creator | Custom Report Layouts':

    a. Choose 'Import Report Package...' and select the ReportPackage - DCR_Demo_<version>.dcr file from the TEMPLATE directory. This imports a default set of layouts and also the report objects (from the FOB file in the package).

    b. Compile Document Creator objects (filter on versionlist @*DCR*).

  8. Navigate to (or search for) 'Administration | Application Setup | RapidStart Services for Microsoft Dynamics NAV | Configuration Packages:

    a. Choose Import Package and select the RapidStart package from the TEMPLATE directory.

    b. Select the imported 'DCR' package, choose Apply Package, then confirm. This imports the default translations for the Document Creator layouts.

Document Creator is ready for use!