Skip to main content

Client Management in Business Central using AL Code

Introduction:

Have you ever got into a requirement, where you are needed to actually execute the logic separately for different client types?

Well, this blog is just going to discuss the ClientType DataType and different ways of getting ClientTypes and how to use it in your code.


Pre-requisites:

  • Microsoft Dynamics Business Central Online
  • AL Language Extension
  • VS Code

References:

Demonstration:

ClientType:
In order to understand how to use ClientTypes, we need to understand what ClientTypes represents.
ClientType is an Option based DataType introduced in Business Central. That is in order to get the value or use the value we need to simply use just like ClientType::<Option Value>

ClientType has the following OptionMembers:
MemberDescription
BackgroundA background client.
ChildSessionA child session client.
DesktopA desktop client.
ManagementA management client.
NASA NAS client.
ODataA NAS client.
PhoneMicrosoft Dynamics Business Central Phone client.
SOAPA SOAP client.
TabletMicrosoft Dynamics Business Central Tablet client.
WebMicrosoft Dynamics Business Central Web client.
WindowsMicrosoft Dynamics Business Central Windows client.
CurrentMicrosoft Dynamics Business Central Windows client.
DefaultThe default client.
ODataV4A ODataV4 client.
ApiAn API client.


Applying ClientType:
In this code, I will explain how to select a specific Client Type in AL Code.
There are two ways of selecting the Client Type.
1. Using Client Type Management Codeunit: The syntax will be
    CU_ClientManagement.GetCurrentClientType

2. Using CurrentClientType function: Just like using 'CurrentCompany' standard function, you can use the CurrentClientType function

 trigger OnOpenPage();
    var
    CU_ClientManagement: Codeunit "Client Type Management";
    ClientType_1 : ClientType;
    begin
        Clear(CU_ClientManagement);
        If CU_ClientManagement.GetCurrentClientType() = ClientType_1::Api then begin 
            Message('API Client Type');
        end;

        If CurrentClientType = ClientType_1::Background then begin 
            Message('Background Client Type');
        end;

    end;
}

Conclusion:

In this blog, we covered what is ClientType DataType and how to use it to find what is the ClientType of the logged-in session.

I have personally discovered this datatype and found out the different ClientTypes that were added recently.

I hope this helps you get a clear understanding, implications, and how to apply it. :) 



Comments

  1. No need to create a ClientType_1 variable, Enum values can be directly accessed as Enums are static.


    trigger OnOpenPage();
    var
    CU_ClientManagement: Codeunit "Client Type Management";
    begin
    Clear(CU_ClientManagement);
    If CU_ClientManagement.GetCurrentClientType() = ClientType::Api then begin
    Message('API Client Type');
    end;

    If CurrentClientType = ClientType::Background then begin
    Message('Background Client Type');
    end;

    end;
    }

    ReplyDelete
  2. Thanks agreed.
    I also wanted to also demonstrate the datatype as well.

    ReplyDelete

Post a Comment

Let me know your comments below. I'll try my best to answer your comment

Popular posts from this blog

Something went wrong. An Error occurred - Error Resolution

Introduction: With the installation of NAV 2018 or BC On-premise, I have observed that when creating New Server Instance and New WebServer Instance, you will get the error 'Something went wrong. An Error occurred '. I referred to the community questions below but didn't find my resolution. Hence, I decided to write this blog. Pre-requisites: Microsoft Dynamics Business Central - On-Premise / NAV 2018 Understanding of Business Central Authentication  Books & References: https://community.dynamics.com/nav/f/microsoft-dynamics-nav-forum/261301/nav-2018-web-client-an-error-has-occurred https://community.dynamics.com/business/f/dynamics-365-business-central-forum/421987/error-something-went-wrong-an-error-has-occurred-azure-ad-tenant Demonstration: 1. Creation of NAVServerInstance: In order to create NAVServerInstance, you can either add the Server Instance through Business Central Administration or Powershell command. Add Instance - Business Central Administration Add Insta

Setting up OAuth Authentication for Business Central Web Services / APIs

Introduction: After upgrading Business Central to version 17 (Wave2 2020), I found that there was an error telling me that WebService Key is going to be deprecated soon. Web Service Access Key is deprecated. Hence, I decided to explore and probably make it easier through this blog. Pre- requisites : Admin Access to Office 365 Admin Access to Azure Demonstration: 1. App Registration on Azure Portal: To enable OAuth authentication for any apps in Azure Active Directory, you will need to perform App Registration and set up the permissions and security details. i.) Register the App: Search for 'App Registration' on the Azure Portal. Click on New Registration Type in the App Names, Account Types and Redirect URI. Registering Application ii.) Setup API Permissions: Go to API Permissions > Add Permissions > Business Central App > Select Delegated Permissions > Select Other Permissions and Financials > Add Permissions Button. Setup API Permissions iii.) Setup Client Secr

How to Upgrade Data from Microsoft Dynamics NAV to Microsoft Dynamics Business Central On Premise - Part 2

 Introduction: Now that the first step of the problem preprocessing of the NAV Database to make it ready to be migrated to BC is done(refer Part 1 ), we can now proceed further with connecting the database in Business Central On-Premise. Pre- requisites : Microsoft Dynamics 365 Business Central Microsoft Dynamics for NAV Microsoft SQL Server Management Studio (SSMS) Powershell ISE Understand NAV to BC Upgrade Considerations -  Click here Understand Upgrade Path -  Click here Books & References: https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/upgrade/upgrade-considerations#online https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/upgrade/upgrade-paths https://www.sauravdhyani.com/2018/10/msdyn365bc-data-upgrade-to-microsoft.html https://olisterr.blogspot.com/2022/03/how-to-upgrade-data-from-microsoft.html https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/upgrade/upgrade-permissions Demonstration: 1. Install Business