Print Manual  

 NAVAX Extension Base


Basic functionality for NAVAX Extensions.
Current Version: 21.2.0.0 as of Business Central 21. For older BC versions, downgrades are available.

Manual


Creation Date: 2024/02/21
The current version of this manual can be found at:

https://www.navax.app/help.php?AppID=NCEX&L=en


☰ Contents



General

  • NAVAX Extension Base
    NAVAX Extension Base provides basic functionality for NAVAX Extensions...

Setup

  • NAVAX License Management
    The NAVAX License Management page (in older versions NAVAX License Overview or NCEX License Overview) displays the current license status of the NAVAX extensions...
  • Version History
    The Version History page shows when which version of the extension was installed...
  • Real Data Permissions
    Real Data Permissions add an additional level of security to actions and processes. This is to prevent test data from being accidentally interpreted as real data. Particularly critical actions and processes (e.g. sending data to an external service) can therefore only be executed if a real data permission has been granted for the current environment...
  • NAVAX Dropzone Setup
    In the NAVAX Dropzone Setup page the settings and defaults for the different Dropzones are defined...

Information for Developers

  • QR Codes
    QR Codes can be created via the CreateQRCodeRedSoft procedure from the NCEX QR Code Mgt. codeunit...
  • Text Editor
    The Text Editor can be opened via the EditText and ShowText procedures from the NCEX Text Editor Mgt. codeunit...
  • Dropzone
    A NAVAX Dropzone can be integrated into a page very easily. Each added dropzone is addressed and identified by a unique ID...
  • PDF Viewer
    PDF files can be displayed via the ShowPDF procedure from the NCEX PDF Viewer Mgt. codeunit...
  • Service Log Request/Response
    Service log requests/responses can be displayed via the ShowJSONRequestResponse, ShowJSONRequest and ShowJSONResponse procedures from the NCEX Service Log Mgt. codeunit...
  • Update Notification
    Update notifications indicate whether updates are available for NAVAX extensions...

Appendix

  • Environment Confirmations (Obsolete)
  • NAVAX Registration (Dynamics NAV AddOns)
    The current registration status of a NAVAX Dynamics NAV AddOn is displayed in the AddOn Setup page in the System group...
  • Installation Notes
  • Release Notes

Docs  /  NAVAX Extension Base  /  General
NAVAX Extension Base

NAVAX Extension Base provides basic functionality for NAVAX Extensions.

Navigation

The search terms "navax", "nvxex" and "ncex" are recognized by "Tell me what you want to do". This allows very fast access to the individual areas of the NAVAX Extension Base.

Note

NAVAX Extension Base was developed with the prefix "NCEX". NCEX stands for NAVAX Consulting Extension Base.

Permission Sets

The following permission sets are available for the NAVAX Extension Base:
NameDescription
NCEXNAVAX Extension Base You need these permissions to use the NAVAX Extension Base.
NCEX, SETUPNAVAX Extension Base Setup You need these permissions to set up the NAVAX Extension Base.

Installation Notes

For more information, see Appendix, Installation Notes.

Docs  /  NAVAX Extension Base  /  Setup
NAVAX License Management

The NAVAX License Management page (in older versions "NAVAX License Overview" or "NCEX License Overview") displays the current license status of the NAVAX extensions. In order for a NAVAX extension to be displayed in this page, the corresponding setup of the extension must first be opened.

Note

Changes as of Version xx.1.16.0 The NAVAX License Management page now supports automatic adding of NAVAX extensions. NAVAX extensions that use this system no longer need to have the corresponding extension setup opened first to be displayed in this page.

Fields

NameSpecifies the name of the Extension.
License StatusSpecifies the current license status of the Extension.
Serial No.Specifies the serial number of the Extension.
VersionSpecifies the currently installed version of the Extension.

Trial Version

A NAVAX extension can be tested or used free of charge for 30 days after installation. After that, the extension can only be used with a valid license.

Note

Changes as of Version xx.1.4.0 The licensing of a NAVAX extension is only necessary in the production environment. In the sandbox environment, NAVAX extensions can be tested unlimited.

Request License

The license can be requested or checked via the Current Status action (in older versions What's New?). This opens a window. The following example shows the NAVAX extension Excel Report Builder. Fill in the fields in the window and then click Send License Request. Please note that the licensing process may take some time. In the next few days you will receive an email with further information.

Note

For licensing, calling the online help and performing some actions, access to https://www.navax.app must be allowed.

Public IP from www.navax.app for setting firewall access:
94.136.22.236, Port: TCP/443

Checking the connection to https://www.navax.app using PS:
Test-NetConnection navax.app -port 443
(PS must be performed with the M-Tier service user)

Activate/Update License

As soon as the licensing has been completed, you will receive an email and the license can be activated via the Update License action. The license is company independent. So it does not matter in which company the action is called.

Note

  • The licence must be updated once a year via the Update License action.
  • The update is only possible or necessary within the last 30 days before the license expires, or afterwards. Within the last 30 days before the license expires, notes are displayed.
  • If the Automatic License Renewal is enabled, the Update License action is called automatically before the license expires. Note that the setting is only active after the license has been activated via the action.

Terms & Conditions

For more information, see https://www.navax.app/EULA.php?L=en

Data Security

For more information, see https://www.navax.app/privacyStatement.php?L=en

Submit Rating

This action can be used to open the Microsoft AppSource ratings page for the extension. We would be very happy if you submit your rating and let us know about your experience with the Extension.

Docs  /  NAVAX Extension Base  /  Setup
Version History

The Version History page shows when which version of the extension was installed.

Fields

VersionSpecifies the version.
DateSpecifies the date since the version was used.

Docs  /  NAVAX Extension Base  /  Setup
Real Data Permissions

Real Data Permissions add an additional level of security to actions and processes. This is to prevent test data from being accidentally interpreted as real data. Particularly critical actions and processes (e.g. sending data to an external service) can therefore only be executed if a real data permission has been granted for the current environment.

Practical example

You create a new test database in an on-premises environment by copying the real database, which contains the fully set up fiskaltrust extension. The service of the fiskaltrust extension has the function to sign documents that are subject to the cash register obligation and to protect them against manipulation. Without an additional security level, data from the test database would also be forwarded to fiskaltrust, where it would be interpreted as real data and reported to the tax office. However, this is prevented by the real data permissions function.

Manage Real Data Permissions

The real data permissions of an extension can be viewed or managed via the setup page of the extension in the system area. Real data permissions can only be granted for production environments and not for sandbox environments. In the setup of the real data permissions, an environment is defined by the company name, the database name and the server name.

Fields

Company NameSpecifies the company name of the permitted environment.
Database NameSpecifies the database name of the permitted environment.
Server NameSpecifies the server name of the permitted environment.
Current EnvironmentSpecifies whether the permitted environment is the current environment.
Date and TimeSpecifies the date and time when the environment was permitted.
User IDSpecifies the ID of the user who permitted the environment.
User NameSpecifies the name of the User ID.

Actions

  • Permit Current Environment

    Grants a real data permission for the current environment.

    Warning

    Do not permit your current environment unless you are absolutely sure. Once the environment is permitted, the secured action or process can be called or executed by all users. Although real data permissions can be deleted or removed at any time, this does not undo actions that have already been performed.

Docs  /  NAVAX Extension Base  /  Setup
NAVAX Dropzone Setup

In the NAVAX Dropzone Setup page the settings and defaults for the different Dropzones are defined. The NAVAX Dropzone can be used by various extensions. These extensions automatically add further options in the Dropzone field. For example, the NAVAX extension NCDD Drag & Drop Document Attachments adds the option NCDD Document Attachment FactBox and the NAVAX extension Finmatics Autonomous Accounting adds the option Incoming Finmatics Documents.

Note

  • NAVAX Dropzones are suitable for upload sizes up to 15000 KB (15 MB).
  • If you change the settings, the page that displays the Dropzone may need to be reloaded or refreshed for the new settings to take effect.

Fields

DropzoneSpecifies for which Dropzone the settings apply. The settings of the Default dropzone apply to all dropzones that do not have their own settings.
Max. Upload Size (KB)Specifies the maximum total size of all files in KB that may be uploaded at the same time. The default value that is suggested is 5000 KB (5 MB). The maximum value that can be entered is 15000 KB (15 MB).
Max. No. of FilesSpecifies the maximum number of files that may be uploaded at the same time.
Allowed File ExtensionsSpecifies which file extensions may be uploaded. If the field is empty, all extensions are allowed. If multiple extensions are allowed, they can be specified separated by a comma. Example: pdf,doc*,xls*,png,txt,zip

Tip

If you specify 'doc', only files with .doc file extension may be uploaded. If 'doc*' is specified, files with file extension .docx, .docm etc. may also be uploaded.
Extract zip FilesSpecifies whether *.zip files should be automatically decompressed or unzipped during upload.
Timeout (Milliseconds)Specifies the duration in milliseconds that a file may take to upload before the process terminates with an error.

Docs  /  NAVAX Extension Base  /  Information for Developers
QR Codes

QR Codes can be created via the CreateQRCodeRedSoft procedure from the NCEX QR Code Mgt. codeunit. Here a service from http://www.redsoft.at is used.

Note

To create the QR Codes, access to the service must also be allowed. For more information, see Appendix, Installation Notes.
The Size parameter of the CreateQRCodeRedSoft procedure can be used to specify the size of the QR Code in pixels. If no value is specified, the QR Codes will be created with a resolution of 200x200 pixels. If the QR Code is displayed blurred on the document, a different specification may improve the print quality. The fiskaltrust POS Interface extension has defined e.g. 600 as the default value. In addition, a different value can be specified there via a field in the setup. For more information, see [Docs] fiskaltrust POS Interface - Setup, Cash Register Setup

Methods

  • CreateQRCodeRedSoft

    Creates a new QR Code.
    procedure CreateQRCodeRedSoft(QRCodeInput: Text; var TempBlob: Codeunit "Temp Blob"; Size: Integer): Boolean

    Parameters

    TypeNameDescription
    TextQRCodeInputThe content of the QR Code to be created.
    Temp BlobTempBlobThe Temp Blob in which the created QR Code is returned.
    IntegerSizeThe size of the QR Code in pixel (default=200).


Docs  /  NAVAX Extension Base  /  Information for Developers
Text Editor

The Text Editor can be opened via the EditText and ShowText procedures from the NCEX Text Editor Mgt. codeunit. Several variants (or several overloads) are available for the EditText function. The ShowText function is only for displaying and not for editing a text. The following examples show different starting situations and possibilities for integrating the text editor.

Save everything in the text field

The text editor can be called e.g. with a variable of the type Text:
procedure EditText(var Text: Text; MaxLineStrLen: Integer; MaxTextLen: Integer; ReadOnly: Boolean) TextModified: Boolean

Parameter

  • Text Specifies the text to be edited.
  • MaxLineStrLen If specified, this can be used to limit the maximum number of characters per line. The text is automatically wrapped when entered in the editor if the length is exceeded. The wrap tries to leave words whole.
  • MaxTextLen If specified, this can be used to limit the maximum number of characters of the entire text.
  • ReadOnly Specifies whether to open the editor in read-only mode. In read-only mode, the text cannot be changed. However, the text can be marked and contents from it can be copied.

Scenario

  • The following example shows the integration of the editor into the Cash Register Sales Slip Text Setup. The table has a text field with a length of 1000 characters:
    ...
    field(10; "Text"; Text[1000])
    {
        DataClassification = CustomerContent;
        Caption = 'Text', Comment = 'DEU="Text"';
    }
    field(15; "Starting Date"; Date)
    {
    ...
    Since a starting date and an ending date can be added to each text line in addition to the text and the text field itself is large enough, the following simple solution was chosen here, which does not split the text into several lines. A line break in the text is still possible. It is important that the text field in the page is set to Editable = false; because in this solution the line breaks (not visible) are also stored in the text field.

Implementation

  • Table
    ...
    procedure EditText(Editable: Boolean)
    var
        NCEXTextEditorMgt: Codeunit "NCEX Text Editor Mgt.";
        TempText: Text;
    begin
        TempText := Text;
        if not NCEXTextEditorMgt.EditText(TempText, 0, MaxStrLen(Text), not Editable) then
            exit;
        Text := CopyStr(TempText, 1, MaxStrLen(Text));
    end;
    ...
    Page
    ...
    field("Text"; Rec."Text")
    {
        ApplicationArea = All;
        ToolTip = 'Specifies the text. Click on the field to edit the text.', Comment = 'DEU="Gibt den Text an. Klicken Sie auf das Feld, um den Text zu bearbeiten."';
        Editable = false;
        AssistEdit = true;
    
        trigger OnAssistEdit()
        begin
            Rec.EditText(CurrPage.Editable());
            CurrPage.Update();
        end;
    }
    ...

Split text over multiple lines

The text editor can also be called with a variable of the type RecordRef:
procedure EditText(RecordRef: RecordRef; TextFieldNo: Integer; var TempBlob: Codeunit "Temp Blob"; ReadOnly: Boolean) TextModified: Boolean

Parameter

  • RecordRef Specifies which table and which records from the table should be loaded into the text editor.

    Important

    Special care must be taken to ensure that the correct filters are set on the RecordRef.
  • TextFieldNo Indicates in which field the text is stored.

    Note

    The maximum number of characters per line (MaxLineStrLen) is determined by the length of the TextFieldNo field in this call. The text is automatically wrapped when entered in the editor if the length is exceeded. The wrap tries to leave words whole.
  • TempBlob Contains the new, edited text.
  • ReadOnly Specifies whether to open the editor in read-only mode. In read-only mode, the text cannot be changed. However, the text can be marked and contents from it can be copied.

Scenario

  • The following example shows a possible integration of the editor into the Extended Text Lines: Since the table "Extended Text Line" contains only the text and the text field with a length of 100 characters is not large enough, the following solution was chosen here, which splits the text over several lines.

Implementation

  • pageextension 50000 "NVX Extended Text Lines" extends "Extended Text Lines"
    {
        actions
        {
            addfirst(Processing)
            {
                action(NVXTextEditorAction)
                {
                    ApplicationArea = All;
                    Caption = 'Text Editor', Comment = 'DEU="Texteditor"';
                    Image = Edit;
                    ToolTip = 'Edit the text in the text editor.', Comment = 'DEU="Bearbeiten Sie den Text im Texteditor."';
    
                    trigger OnAction()
                    var
                        ExtendedTextLine: Record "Extended Text Line";
                        NCEXTextEditorMgt: Codeunit "NCEX Text Editor Mgt.";
                        TempBlob: Codeunit "Temp Blob";
                        RecordRef: RecordRef;
                        InStream: InStream;
                        NextLineNo: Integer;
                        TempText: Text;
                    begin
                        Clear(ExtendedTextLine);
                        ExtendedTextLine.SetRange("Table Name", Rec."Table Name");
                        ExtendedTextLine.SetRange("No.", Rec."No.");
                        ExtendedTextLine.SetRange("Language Code", Rec."Language Code");
                        ExtendedTextLine.SetRange("Text No.", Rec."Text No.");
                        RecordRef.GetTable(ExtendedTextLine);
                        if not NCEXTextEditorMgt.EditText(RecordRef, ExtendedTextLine.FieldNo(Text), TempBlob, not CurrPage.Editable()) then
                            exit;
    
                        ExtendedTextLine.LockTable();
                        ExtendedTextLine.DeleteAll();
                        NextLineNo := 10000;
                        TempBlob.CreateInStream(InStream);
                        while (not InStream.EOS()) do begin
                            Clear(ExtendedTextLine);
                            ExtendedTextLine."Table Name" := Rec."Table Name";
                            ExtendedTextLine."No." := Rec."No.";
                            ExtendedTextLine."Language Code" := Rec."Language Code";
                            ExtendedTextLine."Text No." := Rec."Text No.";
                            ExtendedTextLine."Line No." := NextLineNo;
                            NextLineNo += 10000;
                            InStream.ReadText(TempText);
                            ExtendedTextLine.Text := CopyStr(TempText, 1, MaxStrLen(ExtendedTextLine.Text));
                            ExtendedTextLine.Insert();
                        end;
                    end;
                }
            }
        }
    }

Store text in a blob

Calling the text editor with Codeunit "Temp Blob" without RecordRef is also possible:
procedure EditText(var TempBlob: Codeunit "Temp Blob"; MaxLineStrLen: Integer; MaxTextLen: Integer; ReadOnly: Boolean) TextModified: Boolean

Parameter

  • TempBlob Contains the text to be edited.
  • MaxLineStrLen If specified, this can be used to limit the maximum number of characters per line. The text is automatically wrapped when entered in the editor if the length is exceeded. The wrap tries to leave words whole.
  • MaxTextLen If specified, this can be used to limit the maximum number of characters of the entire text.
  • ReadOnly Specifies whether to open the editor in read-only mode. In read-only mode, the text cannot be changed. However, the text can be marked and contents from it can be copied.

Scenario

  • If the text is to be stored directly to the record (i.e. no splitting to several records) and the solution via a text field is out of question due to the limited field length (depending on the definition max. 2048 characters), the text can also be stored in a blob field. Optionally, another field can be created, which displays a preview of the blob field content. The following example shows a possible solution.

Implementation

  • Table
    ...
    field(50000; "Text Preview"; Text[250])
    {
        DataClassification = CustomerContent;
        Caption = 'Text Preview', Comment = 'DEU="Textvorschau"';
    }
    field(50001; "Text Storage"; Blob)
    {
        DataClassification = CustomerContent;
        Caption = 'Text Storage', Comment = 'DEU="Textspeicher"';
    }
    
    procedure EditText(Editable: Boolean)
    var
        NCEXTextEditorMgt: Codeunit "NCEX Text Editor Mgt.";
        TempBlob: Codeunit "Temp Blob";
        InStream: InStream;
        OutStream: OutStream;
        NewText: Text;
    begin
        CalcFields("Text Storage");
        "Text Storage".CreateInStream(InStream);
        TempBlob.CreateOutStream(OutStream);
        CopyStream(OutStream, InStream);
        if not NCEXTextEditorMgt.EditText(TempBlob, 0, 0, not Editable) then
            exit;
        TempBlob.CreateInStream(InStream);
        InStream.Read(NewText);
        SaveText(NewText);
    end;
    
    procedure SaveText(NewText: Text)
    var
        OutStream: OutStream;
    begin
        "Text Storage".CreateOutStream(OutStream);
        OutStream.Write(NewText);
        "Text Preview" := CopyStr(NewText, 1, MaxStrLen("Text Preview"));
    end;
    ...
    Page
    ...
    field("Text Preview"; Rec."Text Preview")
    {
        ApplicationArea = All;
        ToolTip = 'Specifies the text. Click on the field to edit the text.', Comment = 'DEU="Gibt den Text an. Klicken Sie auf das Feld, um den Text zu bearbeiten."';
        Editable = false;
        AssistEdit = true;
    
        trigger OnAssistEdit()
        begin
            Rec.EditText(CurrPage.Editable());
            CurrPage.Update();
        end;
    }
    ...

Docs  /  NAVAX Extension Base  /  Information for Developers
Dropzone

A NAVAX Dropzone can be integrated into a page very easily. Each added dropzone is addressed and identified by a unique ID.

Note

NAVAX Dropzones are suitable for upload sizes up to 15000 KB (15 MB).
The following example shows how to add a new dropzone.

Scenario

  • A dropzone should be provided on the customer list (Page 22), which can be used to add document attachments via drag & drop:

    Note

    This example serves only to illustrate the simplest implementation. For document attachments, it is recommended to use the NAVAX App NCDD Drag & Drop Document Attachments. This app is also based on NAVAX Dropzone, but integrates it directly with the document attachment FactBox. For more information, see [Docs] NCDD Drag & Drop Document Attachments - General

Implementation

  1. enumextension A NAVAX Dropzone triggers the OnAfterUpload event on a successful "Drag & Drop". The NCEXDropzoneID parameter of the event specifies which Dropzone triggered the event. For each new Dropzone an additional NCEXDropzoneID must be defined, so that it can be uniquely identified in the event. A new NCEXDropzoneID is added or created via an enumextension:
    enumextension 50000 "NVXTEST NCEX Dropzone ID" extends "NCEX Dropzone ID"
    {
        value(50000; "NVXTEST Customer")
        {
            Caption = 'NVXTEST Customer', Comment = 'DEU="NVXTEST Debitor"';
        }
    }
    Through this enum extension, the customer will also have the ability to specify the settings and defaults for the new Dropzone later on the NAVAX Dropzone Setup page:
  2. Add Dropzone The new Dropzone can then be added to the customer list, e.g. as a FactBox:
    pageextension 50000 "NVXTEST Customer List" extends "Customer List"
    {
        layout
        {
            addfirst(factboxes)
            {
                part(NVXTESTDropzone; "NCEX Dropzone")
                {
                    ApplicationArea = All;
                    Visible = true;
                }
            }
        }
    
        trigger OnOpenPage()
        begin
            CurrPage.NVXTESTDropzone.Page.SetDropzoneID("NCEX Dropzone ID"::"NVXTEST Customer");
        end;
    
        trigger OnAfterGetCurrRecord()
        begin
            CurrPage.NVXTESTDropzone.Page.SetCurrRecord(Rec);
        end;
    }

    Note

    This block:
    trigger OnAfterGetCurrRecord()
    begin
        CurrPage.NVXTESTDropzone.Page.SetCurrRecord(Rec);
    end;
    can also be omitted if, for example, you need a Dropzone that is not record related. (e.g. import of payment files of the NAVAX App NCPI Payments Import).

    Note

    An overload with the following additional parameters is also available for the SetDropzoneID function:
    • AdditionalCallID Can be used as needed, and is passed to the OnAfterUpload Event. For example, if several pages share the same NCEXDropzoneID, you can specify the ID of the page (e.g. Page:: "Purchase Invoices") as a parameter and query it later in the event.
    • AdditionalDropzoneText Can be used if necessary to display additional information to users in the Dropzone area.

  3. OnAfterUpload Event The last step is now to react to the OnAfterUpload event of the Dropzone:
    codeunit 50000 "NVXTEST Event Mgt."
    {
        [EventSubscriber(ObjectType::Codeunit, Codeunit::"NCEX Dropzone Mgt.", 'OnAfterUpload', '', false, false)]
        local procedure NVXTEST_NCEXDropzoneMgt_OnAfterUpload(NCEXDropzoneID: Enum "NCEX Dropzone ID"; CurrRecordVariant: Variant; var UploadedTempBlobList: Codeunit "Temp Blob List"; FileNameList: List of [Text]; AdditionalCallID: Integer)
        var
            Customer: Record Customer;
            DocumentAttachment: Record "Document Attachment";
            TempBlob: Codeunit "Temp Blob";
            ConfirmManagement: Codeunit "Confirm Management";
            RecordRef: RecordRef;
            InStream: InStream;
            FileName: Text;
            i: Integer;
            NoOfFiles: Integer;
            NoOfNoContentFiles: Integer;
            NoRecordSelectedErr: Label 'No %1 is selected.', Comment = 'DEU="Es ist kein %1 ausgewählt."';
            UploadMsg: Label 'Do you want to add %1 file(s) to the document attachments of %2 ''%3''?.', Comment = 'DEU="Möchten Sie %1 Datei(en) zu den Beleganhängen von %2 ''%3'' hinzufügen?"';
            NoContentFilesMsg: Label 'Files that have no content cannot be added to the document attachments.\\Number of files not added: %1\Number of files added: %2', Comment = 'DEU="Dateien, die keinen Inhalt haben, können nicht zu den Beleganhängen hinzugefügt werden.\\Anzahl nicht hinzugefügter Dateien: %1\Anzahl hinzugefügter Dateien: %2"';
        begin
            if (NCEXDropzoneID <> NCEXDropzoneID::"NVXTEST Customer") then
                exit;
    
            if (UploadedTempBlobList.Count() = 0) then
                exit;
    
            if not CurrRecordVariant.IsRecord() then
                Error(NoRecordSelectedErr, Customer.TableCaption());
            Customer := CurrRecordVariant;
            if (Customer."No." = '') then
                Error(NoRecordSelectedErr, Customer.TableCaption());
            Customer.Get(Customer."No.");
    
            if not ConfirmManagement.GetResponseOrDefault(StrSubstNo(UploadMsg, UploadedTempBlobList.Count(), Customer.TableCaption(), Customer."No."), true) then
                exit;
    
            RecordRef.GetTable(Customer);
            NoOfFiles := 0;
            NoOfNoContentFiles := 0;
            for i := 1 to UploadedTempBlobList.Count() do begin
                UploadedTempBlobList.Get(i, TempBlob);
                if TempBlob.HasValue() then begin
                    FileNameList.Get(i, FileName);
                    TempBlob.CreateInStream(InStream);
                    Clear(DocumentAttachment);
                    DocumentAttachment.Init();
                    DocumentAttachment.InitFieldsFromRecRef(RecordRef);
                    DocumentAttachment.SaveAttachmentFromStream(InStream, RecordRef, FileName);
                    NoOfFiles += 1;                
                end else
                    NoOfNoContentFiles += 1;
            end;
    
            if (NoOfNoContentFiles <> 0) then
                Message(NoContentFilesMsg, NoOfNoContentFiles, NoOfFiles);
        end;
    }

    Important

    if (NCEXDropzoneID <> NCEXDropzoneID::"NVXTEST Customer") then
        exit;
    This if-condition decides for which Dropzone the code should be executed and must not be omitted under any circumstances. The value must match the added value from the enumextension.

Docs  /  NAVAX Extension Base  /  Information for Developers
PDF Viewer

PDF files can be displayed via the ShowPDF procedure from the NCEX PDF Viewer Mgt. codeunit. Several variants (or several overloads) are available for the ShowPDF function.

Methods

  • ShowPDF

    Displays a pdf in a new page.
    procedure ShowPDF(PDFTempBlob: Codeunit "Temp Blob")

    Parameters

    TypeNameDescription
    Temp BlobPDFTempBlobContains the pdf file to be displayed.


  • ShowPDF

    Displays a pdf in a new page.
    procedure ShowPDF(PDFFieldRef: FieldRef)

    Parameters

    TypeNameDescription
    FieldRefPDFFieldRefThe field that contains the pdf file to be displayed.


  • ShowPDF

    Displays a pdf in a new page.
    procedure ShowPDF(Base64PDFTXT: Text)

    Parameters

    TypeNameDescription
    TextBase64PDFTXTThe field that contains the pdf file to be displayed.


Docs  /  NAVAX Extension Base  /  Information for Developers
Service Log Request/Response

Service log requests/responses can be displayed via the ShowJSONRequestResponse, ShowJSONRequest and ShowJSONResponse procedures from the NCEX Service Log Mgt. codeunit. The procedures can be used for requests and responses which were sent/returned in JSON format and are available in a BLOB field. This opens a page that displays detailed information about what has been sent to and returned from the service. The information can be useful for technical support.

Methods

  • ShowJSONRequestResponse

    Displays a JSON format request/response in a new page.
    procedure ShowJSONRequestResponse(RequestFieldRef: FieldRef; ResponseFieldRef: FieldRef)
    procedure ShowJSONRequestResponse(RequestFieldRef: FieldRef; RequestJSONPartFieldRef: FieldRef; ResponseFieldRef: FieldRef; ResponseJSONPartFieldRef: FieldRef)

    Parameters

    TypeNameDescription
    FieldRefRequestFieldRefThe field that contains the request to be displayed.
    FieldRef[Optional] RequestJSONPartFieldRefThe field that contains the JSON part of the request to be displayed.
    FieldRefResponseFieldRefThe field that contains the response to be displayed.
    FieldRef[Optional] ResponseJSONPartFieldRefThe field that contains the JSON part of the response to be displayed.


  • ShowJSONRequest

    Displays a JSON format request in a new page.
    procedure ShowJSONRequest(RequestFieldRef: FieldRef)
    procedure ShowJSONRequest(RequestFieldRef: FieldRef; RequestJSONPartFieldRef: FieldRef)

    Parameters

    TypeNameDescription
    FieldRefRequestFieldRefThe field that contains the request to be displayed.
    FieldRef[Optional] RequestJSONPartFieldRefThe field that contains the JSON part of the request to be displayed.


  • ShowJSONResponse

    Displays a JSON format response in a new page.
    procedure ShowJSONResponse(ResponseFieldRef: FieldRef)
    procedure ShowJSONResponse(ResponseFieldRef: FieldRef; ResponseJSONPartFieldRef: FieldRef)

    Parameters

    TypeNameDescription
    FieldRefResponseFieldRefThe field that contains the response to be displayed.
    FieldRef[Optional] ResponseJSONPartFieldRefThe field that contains the JSON part of the response to be displayed.


Docs  /  NAVAX Extension Base  /  Information for Developers
Update Notification

Update notifications indicate whether updates are available for NAVAX extensions. The "NCEX Check Update Status Mgt." codeunit can be used to add an update notification, e.g. on the setup page of a NAVAX extension. The following code shows the implementation on a setup page. The code is identical for all extensions.
trigger OnAfterGetCurrRecord()
var
    AppInfo: ModuleInfo;
    UpdateTaskParameters: Dictionary of [Text, Text];
begin
    Clear(UpdateTaskID);
    NavApp.GetCurrentModuleInfo(AppInfo);
    UpdateTaskParameters.Add('AppID', AppInfo.Id());
    CurrPage.EnqueueBackgroundTask(UpdateTaskID, Codeunit::"NCEX Check Update Status Mgt.", UpdateTaskParameters, 0, PageBackgroundTaskErrorLevel::Ignore);
end;

var
    UpdateTaskID: Integer;

trigger OnPageBackgroundTaskCompleted(TaskId: Integer; Results: Dictionary of [Text, Text])
var
    NCEXCheckUpdateStatusMgt: Codeunit "NCEX Check Update Status Mgt.";
begin
    if (TaskId = UpdateTaskID) then
        NCEXCheckUpdateStatusMgt.ShowUpdateNotification(Results);
end;

Docs  /  NAVAX Extension Base  /  Appendix
Environment Confirmations (Obsolete)

Important

Environment Confirmations have been replaced by Real Data Permissions and should no longer be used. For more information, see Setup, Real Data Permissions.
Environment Confirmations add an additional level of security to actions and processes to prevent test data from being accidentally interpreted as real data. These additional secured actions and processes can only be executed if the current environment in which the action is executed is already confirmed or will be confirmed.

Example

Environment Confirmations are used, for example, by the NCCR Cash Register from the cash register posting process. This is to prevent test data from being accidentally forwarded to the external service of fiskaltrust as real data. This case can occur, for example, especially when deploying via On-Premises, if a test or development database (or a test company) has been created based on the real data and is not defined as a sandbox environment. Without another level of security, cash register postings from this test system would also be forwarded to the fiskaltrust service as real data. By using Environment Confirmations, the cash register posting recognizes that the test environment has not yet been confirmed and the user can now respond to the warning.

Testing and Confirmation

An environment is defined by the company name, the database name and the server name. The action or process may be executed if the current environment is found in the environment confirmations and the setting entered in the Confirmed as field matches the setting of the current environment.
  • Environments set as Production can be confirmed as production environment or as sandbox environment. If you confirm the environment as a production environment, all information will be interpreted as real data. If you confirm the environment as a sandbox environment, all information will be interpreted as test data and the action or process may not be executed until the current environment is also set as a sandbox. When deploying via On-Premises, test and development databases should or must be confirmed as a sandboxed environment.

    Warning

    Confirm your current environment only if you are absolutely sure. Once the environment is confirmed, the action or process is confirmed for all users. While environments that have already been confirmed can be deleted at any time, this will not undo any action that has already been performed.
  • Environments set as Sandbox cannot be confirmed as production environment. Confirmation as a sandbox environment is still necessary for security reasons.

Change a confirmation

All confirmed environments of an extension can be viewed from the extension's setup page via the System area. An environment confirmation cannot be changed directly, but must be deleted first. As soon as a secured action or process in the environment is executed, the environment must be reconfirmed.

Tip

The current environment can also be confirmed immediately using the Confirm Current Environment action.

Fields

Company NameSpecifies the company name of the confirmed environment.
Database NameSpecifies the database name of the confirmed environment.
Server NameSpecifies the server name of the confirmed environment.
Current EnvironmentSpecifies whether the confirmed environment is the current environment.
Confirmed asSpecifies whether the environment was confirmed as a production environment (Real Data) or as a sandbox environment (Test Data).
Date ConfirmedSpecifies the date when the environment was confirmed.
Time ConfirmedSpecifies what time the environment was confirmed.
Confirmed BySpecifies the user ID of the person who confirmed this environment.

Actions

  • Confirm Current Environment

    Confirms the current environment as a production environment or as a sandbox environment.

Docs  /  NAVAX Extension Base  /  Appendix
NAVAX Registration (Dynamics NAV AddOns)

The current registration status of a NAVAX Dynamics NAV AddOn is displayed in the AddOn Setup page in the System group.

Fields

VersionSpecifies the currently installed version of the AddOn.
Serial No.Specifies the serial number of the AddOn.
StatusSpecifies the current registration status of the AddOn.

Trial Version

A NAVAX AddOn can be tested or used free of charge for 30 days after installation. After that, the AddOn can only be used with a valid registration.

Request Registration

The registration can be requested or checked via the What's New? action. This opens a window. The following example shows the NAVAX AddOn "NCC Cube". Fill in the fields in the window and then click Send Registration Request. Please note that the registration process may take some time. In the next few days you will receive an email with further information.

Note

For registration, calling the online help and performing some actions, access to https://www.nccube.com and https://www.navax.app must be allowed. In addition, TLS 1.2 is required. For more information, see How to get earlier versions of the Dynamics NAV development environment to work with TLS 1.2 Public IP from www.navax.app for setting firewall access: 94.136.22.236, Port: TCP/443 Checking the connection to https://www.navax.app using PS: Test-NetConnection navax.app -port 443 (PS must be performed with the M-Tier service user)

Activate/Update Registration

As soon as the registration has been completed, you will receive an email and the registration can be activated via the Update Registration action. The registration is company independent. So it does not matter in which company the action is called.

Note

  • The registration must be updated once a year via the Update Registration action.
  • The update is only possible or necessary within the last 30 days before the registration expires, or afterwards. Within the last 30 days before the registration expires, notes are displayed.

Terms & Conditions

For more information, see https://www.navax.app/EULA.php?L=en

Data Security

For more information, see https://www.navax.app/privacyStatement.php?L=en

Docs  /  NAVAX Extension Base  /  Appendix
Installation Notes

Publish and Install the Extension


All necessary steps are described here:
[Microsoft Learn] Business Central - Publishing and Installing an Extension

On-Premises

The following Granules are required for an On-Premises installation:
  • 1010860 Extension Base by NAVAX

External Addresses

  • https://www.navax.app

    For licensing, calling the online help and performing some actions, access to https://www.navax.app must be allowed.

    Public IP from www.navax.app for setting firewall access:
    94.136.22.236, Port: TCP/443

    Checking the connection to https://www.navax.app using PS:
    Test-NetConnection navax.app -port 443
    (PS must be performed with the M-Tier service user)
  • https://qr01.navax.com:8080

    To create the QR Codes via the CreateQRCodeRedSoft function, access to https://qr01.navax.com:8080 must be allowed.

    Checking the connection to https://qr01.navax.com:8080 using PS:
    Test-NetConnection qr01.navax.com -port 8080
    (PS must be performed with the M-Tier service user)

Docs  /  NAVAX Extension Base  /  Appendix
Release Notes

Would you like to know what has changed in the extension?
Below you'll find an overview of the new features and changes made in the updates.

Version 21.2.0.0

as of Business Central 21
  • Note

    This version is also available as a downgrade version for Business Central 20, 19, 18, 17, 16 and 14.
  • New Product Name

    • The NCEX Extension Base extension has been renamed to NAVAX Extension Base.

Version 21.1.17.0

as of Business Central 21
  • Improvements

    • The NAVAX License Management page displays notifications when updates for NAVAX extensions are available. Developers can also add an update notification on the extension's setup page. For more information, see Information for Developers, Update Notification.

Version 21.1.16.0

as of Business Central 21
  • Improvements

    • The NAVAX License Management page now supports automatic adding of NAVAX extensions. NAVAX extensions that use this system no longer need to have the corresponding extension setup opened first to be displayed in this page.

Version 21.1.15.0

as of Business Central 21

Version 21.1.14.0

as of Business Central 21
  • Improvements

    • The NAVAX License Overview has been renamed to NAVAX License Management.
    • The page NAVAX News has been added. The page displays current news about NAVAX extensions and can be accessed directly or via the NAVAX License Management.
    • For developers, the additional parameters AdditionalCallID and AdditionalDropzoneText have been added to the SetDropzoneID Dropzone function. For more information, see Information for Developers, Dropzone.

Version 21.1.13.0

as of Business Central 21
  • Improvements

    • Since there have been increased requests to reintroduce the automatic license renewal, we have decided to make this feature available again in a slightly modified form. The following changes were made:
      • The automatic license renewal is now no longer activated automatically, but must be activated manually for each extension in the NAVAX License Overview.
      • The license check (and thus also the automatic license renewal) is not called more frequently in the last 7 days before the license expires.
      • Information for Developers: If necessary, the automatic license renewal can be skipped when calling the license check via the SkipAutoLicenseRenewal parameter.
      For more information, see Setup, NAVAX License Management.

Version 21.1.12.1

as of Business Central 21
  • Corrections

    • Correction related to the disabled automatic license renewal.

Version 21.1.12.0

as of Business Central 21
  • Improvements

    • The licensing process has been improved.
  • Modifications

    • Disabled and removed the Automatic License Renewal setting in the NAVAX License Overview page. For more information, see Setup, NAVAX License Management.

Version 21.1.11.0

as of Business Central 21
  • Improvements

    • The licensing process has been improved.
  • Corrections

    • Some messages in the Environment Confirmations section have been corrected.

Version 21.1.10.0

as of Business Central 21

Version 20.1.9.0

as of Business Central 20
  • Improvements

    • Online communication now shows more details if the connection fails.

Version 20.1.8.0

as of Business Central 20
  • Improvements

    • Updating the license is now also possible via a Unlock Code. For more information, see Setup, NAVAX License Management.
    • The Current Status action in the NAVAX License Overview can now also be called for "Currently not installed" entries. The call then shows which extension it is.

Version 20.1.7.0

as of Business Central 20
  • Modifications

    • The UpdateWebPageViewer function in the Text Editor is now no longer local.

Version 20.1.6.0

as of Business Central 20
  • Modifications

    • The phrase "by NAVAX" has been removed from the product name.

Version 20.1.5.0

as of Business Central 20

Version 19.1.4.0

as of Business Central 19
  • Modifications

    • The licensing of a NAVAX extension is now only necessary in the production environment. In the sandbox environment, NAVAX extensions can now be tested unlimited. Updating the license in a sandbox environment is no longer possible. For more information, see Setup, NAVAX License Management.
    • More Notes are now displayed within the last 7 days (previously 3 days) before the license expires.

Version 19.1.3.0

as of Business Central 19
  • Improvements

  • Modifications

    • The What's New? action in the NAVAX License Overview has been renamed to Current Status. The status information is no longer opened in a separate browser window, but directly in Business Central.

Version 19.1.2.0

as of Business Central 19
  • Quality of life update

Version 19.1.1.0

as of Business Central 19
  • Business Central Update

  • Modifications

    • The parameters of the license check have been changed.

Version 18.1.0.0

as of Business Central 18
  • Modifications

    • Removed the commits associated with the license check.

Version 18.0.1.0

as of Business Central 18
  • Modifications

    • The CreateQRCode function in the NCEX QR Code Mgt. codeunit has been replaced by the CreateQRCodeRedSoft and CreateQRCodeTECIT functions. For more information, see Information for Developers, QR Codes.

Version 18.0.0.0

as of Business Central 18
  • Business Central Update

  • Modifications

    • In the environment confirmations, the server name is now fixed to the value 'SaaS' for a SaaS infrastructure.

Version 17.0.1.0

as of Business Central 17

Version 17.0.0.0

as of Business Central 17
  • Initial Version

  Print Manual  
DE|EN Imprint