Initializing your database

After the technical installation of the NAVcommerce add-on, it is time to initialize and configure your database. This all starts the first time you open the setup page. To do so, go to Departments > NAVcommerce > Administration > Setup. Open the setup card and the system will ask you whether you want to initialize your database. Initializing means that the integration mechanism within NAVcommerce will evaluate all data in order to see whether a record has to be synced with the e-commerce environment. Please click yes in order to continue. Depending on the size of your database this might take a little while.

Installing the control add-ins

Directly after the initialization run, the system will ask you to install the control add-ins. In most cases, you would just click yes. Only when running in a multi-tenant environment there is a different route to take. See below.

Installing the control add-ins – Multi-tenant

When your database runs in a multi-tenant environment (SaaSplaza, 1ClickFactory, etc), it might be that you have to ask your tenant administrator to install the control add-ins. Please ask them to follow the same route as described above, and click on the link in the menu ‘Install/Update Control Add-Ins’. This should create and enable the control add-ins for all possible tenents.

The setup page

Version and Status

In the top tab of the setup page, you can see which version of NAVcommerce you are running and whether there is a newer version available. To obtain any newer version, just click Check For Product Updates in the ribbon bar.

The connection statuses will first appear in red. But after going through the next few steps in this manual, you will soon see them turning green.


This is where you have to enter the app details you received from your implementation partner. With the terminology of NAVcommerce every installation is an app. And every app has its own set of keys. The combination of AppId and Key is used to authenticate your specific instance when connecting to the central integration platform.
Besides the credentials, you also have to provide an API Url. You received this Url together with the AppId and Key. But if you don’t have it, you can use,,, depending on your region. There are more regions available, so contact us if you need your data and API’s to be located anywhere else.


Here you have to provide credentials and the REST Url for your Magento environment. If you don’t this information, please follow the procedure at Create Integration to create an integration. At the last step of that process Magento shows a screen with 4 keys on it. Take the one called Access Token, and paste that into the Access Token field on the setup page. The API Url should be the Magento REST API Url. This usually looks like

Note that in previous versions < .46 there were still 2 fields (Magento API Username, Magento API Key). If that is what you see on your screen, just type Magento API Username = nav, Magento API Key = Access Token.

In the drop-down please select the Magento version which you are currently running.


Continuously Sync Item Data – Should only be used when you want your standard NAV item card to be in the lead for the item name field. By default NAVcommerce only takes the item name from the description field once. And after that, you can alter it so that you have a better looking item name on the web. This is what 9 out of 10 customers prefer to do. But if you want the NAVcommerce item card to follow whatever changes you make on standard item description field, then check this option.

Maximum image width/height – Leave blank/0 if you don’t want to apply any resizing. Or fill in something like 1000 × 1000 if you do want the system to resize images. But, be aware, the system will also store the original image file. So its always better to prepare your images before uploading instead of just using the resizer.

Enable Product Documents Extension – Magento by default doesn’t support product documents, but NAVcommerce supports the use of the Amasty Product Attachments extension. After installing this extension, you can check this box, and you can start adding product documents on the NAVcommerce item page. Please see for more details.


Advanced Account Management – This switches NAVcommerce from using a single login per customer account, to logins at contact level. For this to work you also need to install the CMINDS multi user account extension on the Magento side. Please see this link for more details:

Sales Document History – This is a negative value, in the form of a date filter, to tell the system for which period you want to upload sales document history. Type in -2Y, and your customers will see 2 years of historical orders/shipments/invoices when they logon to your web store.

Password – The 3 fields related to password are used when the system generates a new initial password which is used when sending invites to new customers.

Just as with items, you can make NAVcommerce to follow the name and email address fields on the standard customer and contact cards. If you want those to be continuously copied to the web customer card and web contact card, just check the corresponding checkboxes.

No. Series

Per entity within NAVcommerce, you can specify a number series. The series for Documents, Images, Categories, Category Images and Notifications are created by the initialization process, and you most probably don’t want/need to change those.

For customers (this one is used when the system creates a new customer, in case customers can register new accounts via the webstore), you could think about using your standard No. Series. But if you want ‘web customers’ to use another series, then create and select that new one.

For sales orders you have even more options;

  • You can select your standard sales order number series. In this case, the order number which was handed out by Magento will be stored as the External Document Number.
  • You can create a new number series, specifically for ‘web orders’. This might help if you want to distinguish web orders from non-web orders. Although this can be done many other ways as well.
  • You can leave this field blank. In that case, the system will use the Magento order number as the NAV orders number. And, if you want this, but you do want Magento to create numbers that don’t just look like #0000001, then you should have a look at this extension:


For each entity you find on this tab, you can select a configuration template. The functionality which is used here is the standard NAV configuration template system. In short, configuration templates allow you to set default values when a record gets created. So, if you want all your items to be visible by default, just create a template for the NC Item table, select the Visibility field, and provide the value you want to use (probably ‘Catalog and Search’).


This tab contains one field where you can select a category code. If selected, all items in your catalog will be added to this category. In a standard installation, you don’t need this. But, many web developers use this ‘trick’ to develop certain types of landing pages. So if your developer asks for it, the solution is right here.


If you want the system to use the NAV pricing mechanism instead of just showing the unit price as your default price, then you can create a customer and set prices and discounts for that customer. If you leave this field blank, the system will just use the unit price which is set on the item page. If you do fill in a value, you should also fill in the other field, because the system needs to create temporary order lines in order to calculate prices.

If you are running a B2B shop, and you don’t want to show prices when customers are not logged in, don’t bother to fill in these fields, because the B2B pricing extension will take care of everything you need.


The system by default calculates inventory based on the following formula: Available quantity – Quantity on Sales Orders. With this tab you could add additional filters to that calculation. And, when you prefer to use a completely custom code unit you can select that custom code unit right here. (Requires SDK module)


Magento has just 1 type of customer group. NAV has more than one group field you can use. Some customers see the Customer Discount Group as their primary segmentation field, other customers use the Customer Price Group or sometimes even one of the posting groups is used. With this setup field you can tell which NAV field is used to map to the customer groups on the Magento side.
For more information about the mapping that has to be done see this page:

Order Processing

Use the Automatically Process Orders checkbox to tell the system to either leave all incoming ‘web orders’ in the in-between table, or to create NAV sales orders directly.

The standard order processing code unit is 11260665 (NC Sales Order Mgt.), but when you have the SDK module enabled you can also select your own custom code unit. If you want to create a custom code unit for sales order processing you best start by copying the standard one and then modify so that it fits your specific scenario.

Order Processed Status Code – This is the status code that is used by NAV to tell Magento that NAV is now processing this order. The default value is ‘nav_processing’.

The default setup is that the system does not create a sales line when there is no shipping cost. But, if you do want to show free shipping on your sales order, check this box.


Here you can tell the system for which sales documents you want to show historical information. Enable an entity by checking the checkbox, and next to that you can tell which report should be used when customers request a PDF copy of that sales document.


During the implementation and testing phases of your project, you might want to see on a per-record level what is happening in terms of data synchronization. Check this checkbox to enable full integration logging.

Web Services

In a default setup, these can all be left blank. Only if you start using the Reports feature in the NAVcommerce GDF module you have to fill in these fields.

Was this helpful?

Yes No
You indicated this topic was not helpful to you ...
Could you please leave a comment telling us why? Thank you!
Thanks for your feedback.