Restrictions on UI for objects exposed as web services
Pages and code units that are designed to be exposed as Web services must not generate any UI that would cause an exception in the calling code.
SUMMARY AND INTENT: When writing code for Web services, you must not use end-user confirmation dialog boxes, message boxes, or any other page constructs in the code. Because a web service runs independently of a user interface, running this type of code causes the code to throw an exception. The exception can be caught and handled, but the web service won't complete.
RESOURCES: For more information, see Microsoft Dynamics NAV Web Services.
HOW TO COMPLY: Ensure that code for pages and code units that are being exposed as web services don't use any end-user confirmation dialog boxes or message boxes.
TEST METHODOLOGY: To verify this requirement, the following tests will be performed:
- Identify the pages and code units that are exposed as web services during the installation of the extension.
- Using code inspection, verify that methods from the following table aren't used by the pages and code units published by the installation without conditional code that is based on GuiAllowed=false or CurrFieldNo=0 circumventing their call.
| AL Method | Applies to |
|---|---|
| Confirm | Codeunit/page |
| StrMenu | Codeunit/page |
| (Page RunModal) | Page |
| Page of type Confirmation Dialog | Page |
| (Request page) | Page |
| Error | Codeunit/page |
| Beep | Codeunit/page |
| Yield | Codeunit/page |
Additionally, when running the page or code unit as a web service, the following exception should never occur:
Microsoft.Dynamics.Nav.Types.Exceptions.NavNCLCallbackNotAllowedException: Callback functions are not allowed.
Related information
Checklist for submitting your app
Rules and guidelines for AL code