GETURL Function

  • Article

Generates a URL for the specified client target that is based on the configuration of the Microsoft Dynamics NAV Server instance.

If the code runs in a multitenant deployment architecture, the generated URL will automatically apply to the tenant ID of the current user.

[String :=] GETURL(ClientType[, Company][, Object Type][, Object Id][, Record/RecordRef][, UseFilters])

Parameters

  • ClientType
    Value: CURRENTCLIENTTYPE (or Current), DEFAULTCLIENTTYPE (or Default), Windows, Web, SOAP, or OData

    Specifies the client that you want to generate the URL for. This parameter is required. If you want to generate a URL that depends on the client that the user is accessing the URL from, choose Current. The following table describes the options.

    Option Description

    CURRENTCLIENTTYPE

    or

    ClientType::Current

    The URL is generated based on the client that invokes the code, provided that this is one of the client types that are specified in this list. If the URL is requested by another client type, such as a NAS session, Microsoft Dynamics NAV generates a URL based on the default client that is specified for the relevant Microsoft Dynamics NAV Server instance.

    Dn271674.note(en-us,NAV.90).gifNote
    If you specify current as the client type, the URL cannot be consumed by an OData web service.

    DEFAULTCLIENTTYPE

    or

    ClientType::Default

    The URL is generated based on the default client that is specified for the relevant Microsoft Dynamics NAV Server instance.

    ClientType::Windows

    The URL is generated based on a request from the Microsoft Dynamics NAV Windows client.

    ClientType::Web

    The URL is generated based on a request from the Microsoft Dynamics NAV Web client.

    ClientType::Desktop

    The URL is generated based on a request from the Microsoft Dynamics NAV Web client running the Microsoft Dynamics NAV Universal App.

    ClientType::Tablet

    The URL is generated based on a request from the Microsoft Dynamics NAV Tablet client.

    ClientType::Phone

    The URL is generated based on a request from the Microsoft Dynamics NAV Phone client.

    ClientType::SOAP

    The URL is generated based on a request from a SOAP web service.

    ClientType::OData

    The URL is generated based on a request from an OData web service.

    Warning

    A runtime error occurs if the ClientType is set to SOAP or OData but the specified object type and ID has not been published as a web service.

  • Company
    Type: Text Specifies the company that the URL must contain. If you do not specify a company, the URL will run in the user’s current company.
  • ObjectType
    Value: Table, Page, Report, Codeunit, Query, or XMLport Specifies the object type that the URL must open. If you specify an object type, you must also specify an object ID in the ObjectId parameter. Otherwise, the user will see a runtime error. If you set the ObjectType parameter to Page, you can also specify a record variable in the Record parameter.
  • ObjectId
    Type: Integer Specifies the ID of the specified object type that the URL must open.
  • Record/RecordRef
    Type: Record or RecordRef variable The Record or RecordRef variable that specifies which record to open.
  • UseFilters
    Type: Boolean Specifies whether to include filters that are defined on the object as a text string in the URL.

Property Value/Return Value

Type: String

Remarks

The GETURL function generates a URL to open a specific page, for example, or to read Microsoft Dynamics NAV data from a web service. The generated URL includes settings from the configuration of the Microsoft Dynamics NAV Server instance which the code that uses the function runs in. This means that you can use the GETURL function to generate URLs that are generic. The URLs are generated based on the Microsoft Dynamics NAV Server configuration for the user who is accessing the code that generates the URL. If you specify a company, then the URL applies to that company only. Also, in a multitenant deployment, the URLs are tenant-specific. The URL will only allow access to the requested object if the user has permission to access to the object.

Warning

GETURL returns an empty string if the specified parameters result in values that are not valid, and if the URL cannot be generated for other reasons. If the function returns an empty string, you can use the GETLASTERRORTEXT function to troubleshoot. For more information, see GETLASTERRORTEXT Function.

For example, you can write code that will open page 21 in the Microsoft Dynamics NAV Web client. In that case, you call the GETURL function that has the relevant parameters, and when the code runs, the name of the Microsoft Dynamics NAV Server instance and the server name are extracted automatically. The following table describes the basic URLs that you get with the simplest use of the GETURL function by writing url := GETURL(ClientType::Default), 'CRONUS International Ltd.';.

Client URL

Microsoft Dynamics NAV Windows client

DynamicsNAV://server:port/instance//CRONUS International Ltd.

Microsoft Dynamics NAV Web client

https://server:port/instance/WebClient?company='CRONUS International Ltd.'/

Microsoft Dynamics NAV Tablet client

ms-dynamicsnav://server:port/instance?company=’ CRONUS International Ltd.’

Microsoft Dynamics NAV Phone client

ms-dynamicsnav://server:port/instance?company=’ CRONUS International Ltd.’

Microsoft Dynamics NAV Desktop client

ms-dynamicsnav://server:port/instance?company=’ CRONUS International Ltd.’

OData

https://server:port/instance/OData/Company('CRONUS International Ltd.')/

SOAP

https://server:port/instance/WS/CRONUS International Ltd.

In the example, an empty string for the company name is included for clarity. But an even simpler use of GETURL is to only specify the client type as in url := GETURL(ClientType::Default);.

URLs for opening a page or a report are available from the About this Page windows. For more information, see Using About This Page and About This Report.

Example

The following code example illustrates how you can use the GETURL function to generate a URL that will open page 21 in the client that the current user is using.

Cust.Get(10000);
url := GETURL(CURRENTCLIENTTYPE, 'COMPANYNAME', ObjectType::Page, 21, Cust);
// Alternatively, you can use the following code:
//Cust.Get(10000);
//url := GETURL(ClientType::OData, COMPANYNAME, ObjectType::Page, 21, Cust);

When the code runs, a different URL is generated, depending on the client that is using the URL. If the code is run in the context of a SOAP web service, it has a different syntax than if it runs in the context of the Microsoft Dynamics NAV Windows client. The following table describes the syntax of the generated URL for each client type.

Client URL

Microsoft Dynamics NAV Windows client

DynamicsNAV://server:port/instance/company/runpage?page=21&bookmark=bookmark

Microsoft Dynamics NAV Web client

https://server:port/instance/WebClient?company&page=21&bookmark=bookmark

OData

Not applicable because the client type is set to Current, which is not supported for Odata web services.

SOAP

Not applicable because the URL for SOAP web services does not support filtering for the record.

The current version of Microsoft Dynamics NAV cannot generate a URL for an OData client if the client type is set to Current. However, the following code example illustrates a similar scenario for opening page 21 and specifying the record so that the URL can be consumed by an OData web service:

Cust.Get(10000);
url := GETURL(ClientType::OData, COMPANYNAME, ObjectType::Page, 21, Cust);

In this example, the following URL is generated for OData web services:

https://server:port/instance/OData/Company('company')/Customer('10000')

In this example, it is assumed that page 21 is published as an OData web service with the name Customer.

The following code example illustrates a similar scenario for opening page 21 and not specifying the record so the URL can be consumed by a SOAP web service:

url := GETURL(CURRENTCLIENTTYPE, COMPANYNAME, ObjectType::Page, 21);
// Alternatively, you can use the following code:
//url := GETURL(ClientType::Current, COMPANYNAME, ObjectType::Page, 21);

In this example, the following URL is generated for SOAP web services:

https://server:port/instance/WS/company/Page/Customer

See Also

Tasks

How to: Copy the URL to Open a Page or Report
How to: Publish a Web Service

Reference

HYPERLINK Function
CURRENTCLIENTTYPE Function
DEFAULTCLIENTTYPE Function

Concepts

Creating and Running Hyperlinks