NAV 2017 – Delivering custom code as extension

Standard

We can still deliver our custom code as a fob in NAV 2017 as most VARs will continue to do so in the foreseeable future, however it seems to me that ISVs will embrace faster the new method. While in my first blog on extensions I was focused on explaining the basics of the technical side of creating an extension, in this blog I will delve into delivering a functional requirement as an extension.

I will go through an exercise of adding a new field: “Created By” Code 20 (a valid user from User table)  to Sales documents.

If you’re planning to follow this exercise please review “Setting up your working space” from my previous blog.

I will make this new field available on:

  • Table 36 “Sales Header”
  • Table 112 “Sales Invoice Header”
  • Table 114 “Sales Cr. Memo Header”
  • Page 43 “Sales Invoices”
  • Page 44 “Sales Credit Memo”
  • Page 132 “Posted Sales Invoices”
  • Page 134 “Posted Sales Credit Memo”.

The field will be passed on and made visible on

  • Page 20 “G/L Entries” and
  • Page 25 “Cust. Ledger Entries”

when we drill down on different tables exposed via Navigate action on the posted document.

At this moment, delta files for reports (standard report modifications) cannot be part of an extension. Please visit Extension Packages Capability Support Matrix for updates on this topic.

Therefore my attempt to modify the report 1306 to add the new field in the layout and report failed:

ext21

Delivering modifications to reports must be done in a different way. One alternative is to add a new action on the Posted Sales Invoice and point to a copy of report 1306 (modified to include our field). Therefore our custom code won’t be extension-only based.

This link contains a fob with all the modifications done to a Demo Database 2017 CU9.

The steps to create and publish the extension are very similar to the steps in my previous blog located here.

Let’s test the changes by pointing our Service tier to the target database and publish there the new extension.

First let’s install the extension, by opening page 2500 “Extension Management”:

ext22

Let’s open Sales Invoice page and create a new invoice. The “Created By” field should be in the first FastTab and auto-populated with the logged in user:

ext23

After posting the invoice we notice that the new field is part of the “Posted Sales Invoice” as well:

ext24

Next we want to check the existence of this new field in page “General Ledger Entries” and page “Cust. Ledger Entries”. In the “Posted Sales Invoice” page, in the Actions tab, click on Navigate, and check the 2 pages:

Ext25

ext26

At the core of this simple exercise is the codeunit 50000 in which I subscribed in a few instances to standard events like OnAfterInsertEvent:

 ext28

Thank you for reading, sharing, commenting, liking, following 🙂

 

How To : 5 Easy Steps to generate your First NAV Extension

Standard

Thank you for landing here.

It’s quite common nowadays to hear NAV people talking about Dynamics 365, AppStore, extensions, new AL language and the Visual Studio Code.

So extension is a concept that sooner or later NAV developers need to grasp.

In this blog I will create one simple extension. I have seen a few demos on the web, but I had  a few issues following them. I will highlight these issues as I go.

I encourage everyone to visit msdn page on this topic.

1. Setting up your working space

On my development machine I installed NAV 2017 CU 9. I will be working with 3 databases which initially will be restored from your NAV DVD, from the folder below:

SQLDemoDatabase\CommonAppData\Microsoft\Microsoft Dynamics NAV\100\Database
  • restore via SQL Server Management Studio the Demo database as Demo Database NAV (10-0) (we won’t touch this – it will be our ORIGINAL DB)
  • restore via SQL Server Management Studio the Demo database as TestExtension (we will make modifications on this database – it will be our MODIFIED DB)
  • restore via SQL Server Management Studio the Demo database as ApplyExtension (we will install our extension here – it will be our TARGET DB)
  • create a NAV service(I named mine TestExtension) pointing to the database you will be working with in the development environment, in our case is TestExtension
  • created 3 folders on your local drive: ORIGINAL, MODIFIED, DELTA

2. Create extension content

I added field 50000 “Planet No.” – Integer on table 14 Location.

I added this new field to Page 15, “Location List”.

I created a new codeunit, 50000, TestExtension, with 2 empty and local functions:

Extension1

And these are the 3 objects:

Ext2

3. Populate local folders: ORIGINAL,MODIFIED and DELTA:

a. Populate ORIGINAL:

Point Service tier towards Demo Database NAV (10-0) and from Dev. environment export all objects (or just Table 14 and Page 15 if you want a faster text file processing) as Original.txt. As this file contains a concatenation of all objects we will need to split the big file into smaller ones (one per object). In the ORIGINAL folder create a Split folder. From the Dynamics NAV 2017 Administration Shell run:

Split-NAVApplicationObjectFile -Source .\original\*.txt -Destination .\original\split\

And this is the end-result:

ext3

b. Populate MODIFIED

Point Service tier towards TestExtension and from Dev. environment export all objects (or just Table 14 and Page 15 if you want a faster text file processing) as Modified.txt.
For the same reason as in the previous step split big Modified file:

 Split-NAVApplicationObjectFile -Source .\Modified\*.txt -Destination .\Modified\split\

c. Populate DELTA

To create Delta files run:

Compare-NAVApplicationObject -OriginalPath .\ORIGINAL\SPLIT\ -ModifiedPath .\MODIFIED\Split\ -DeltaPath .\DELTA\
Processed 4965 objects:
 Inserted 1 objects
 Deleted 0 objects
 Changed 2 objects
 Identical 4963 objects
 Failed 0 objects

Have a look at the composition of a Delta file:

ext4

4. Create NAVX file (extension file)

From the Microsoft Dynamics NAV 2017 Administration Shell run:

 New-NAVAppManifest -Name "FirstExtension" -Publisher "SVIRLAN.com" -Version "1.0.0.0" | New-NAVAppPackage -Path FirstExtension.navx -SourcePath .\DELTA

5. Publish extension

To publish the new extension in the ApplyExtension database, point your service tier towards the ApplyExtension database and from the Microsoft Dynamics NAV 2017 Administration Shell run:

 Publish-NAVApp -Path .\FirstExtension.navx -ServerInstance TestExtension -SkipVerification

Open page 2500 “Extension Management” and click Install on our new extension:

ext5

You can Un-install the extension(via action on Page 2500) and you can Un-publish it via “Un-Publish” powershell command.

Facts:

Let’s have a look at what we’ve got by applying our extension to the ApplyExtension database:

The Locations page contains the new field:ext6

But when looking at the objects we dont see the codeunit 50000, the new fields nor the changes in the Version List:

ext8

ext9

Moreover, trying to add the field 50000 in the Location table prompts this system error:

ext7

This makes sense!

The code in table14 and Page 15 remained as delivered by Microsoft, and the extension fields are somehow managed internally via system objects like tables 2000000150 – 2000000163.

Issues encountered:

1. First error I encountered was: “The package contains changes to the database schema that are not handled in upgrade code.”

I needed a codeunit to subscribe to standard published events:
That’s the reason I have codeunit 50000 and the 2 functions:
OnNavAppUpgradePerDatabase()
OnNavAppUpgradePerCompany()

PS C:\docs\blogs\Extensions> New-NAVAppManifest -Name "Proseware SmartStuff" -Publisher "Proseware, Inc." -Version "1.5.0.12" | New-NAVAppPackage
 -Path MyExtension.navx -SourcePath DELTA
 New-NAVAppPackage : The package contains changes to the database schema that are not handled in upgrade code.
 At line:1 char:100
 + ... 1.5.0.12" | New-NAVAppPackage -Path MyExtension.navx -SourcePath DELT ...
 + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 + CategoryInfo : InvalidArgument: (Microsoft.Dynam...ewNavAppPackage:NewNavAppPackage) [New-NAVAppPackage], InvalidOperationExcepti
 on
 + FullyQualifiedErrorId : Microsoft.Dynamics.Nav.Apps.Tools.NewNavAppPackage

2. Second issue happened when running the Publish-NAVApp command: “Access is denied. You need to be a member of the local Administrators group on the server to run this cmdlet.”

Need to run powershell as Admin:

PS C:\docs\blogs\Extensions> Publish-NAVApp -Path .\FirstExtension.navx -ServerInstance TestExtension -SkipVerification
 Publish-NAVApp : Access is denied. You need to be a member of the local Administrators group on the server to run this cmdlet.
 At line:1 char:1
 + Publish-NAVApp -Path .\FirstExtension.navx -ServerInstance TestExtens ...
 + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 + CategoryInfo : NotSpecified: (:) [Publish-NAVApp], NavCommandException
 + FullyQualifiedErrorId : MicrosoftDynamicsNavServer$TestExtension,Microsoft.Dynamics.Nav.Apps.Management.Cmdlets.PublishNavApp

3. In case any of the powershell cmdlets is not recognized in your environment run:

PS C:\docs\blogs\Extensions> Import-Module “C:\Program Files (x86)\Microsoft Dynamics NAV\100\RoleTailored Client\Micro
soft.Dynamics.Nav.Model.Tools.psd1” –force

Thank you for reading, sharing, commenting, liking, following 🙂