BeyondERP.Newsletter
Menu

Setup page · Warehouse management

External service instances

A setup page where you define a specific instance of an external service, including its base URL, authentication secret and logging settings.

Used by
Field Service Integration User, Production supervisor, Process engineering manager and 2 more roles
Business process
Manage warehouse operations
Menu item
WhsExternalServiceInstances
Main table
WhsExternalServiceInstance
Data entity
WHSWarehouseExternalServiceInstanceEntity
Setup steps
1 on this page
Show what matters for
PAGE GUIDEWhat the page does and how to use it8 sections. Choose a role to highlight what matters to you.
Everyone

1What it is and why

What it isA setup page where you define a specific instance of an external service, including its base URL, authentication secret and logging settings.
What you do hereUse this page to connect an external service definition to the actual service that the system calls, and to set how its requests are logged.
ExampleFor example, you can set up multiple warehouses, each of which has its own on-premises installation of labeling software.
External service instances page in Dynamics 365
The page in Dynamics 365. page title tab to open what to set or check
Functional consultant · Solution architect

2Where it fits

Business processManage warehouse operations
Menu pathWarehouse management › Setup › External Services › External service instances
Set up firstExternal service definitions Microsoft Learn
Used next byLabel printers Microsoft Learn
Related pagesExternal service request log Microsoft Learn
End user · Functional consultant

3How to do it

About the examples: Examples and screenshots in this guide use BEAT, a demo company in a Dynamics 365 test environment. Use your own company's codes and values instead of copying them.

Setup steps on this page

Set up External service instances

Use this page to connect an external service definition to the actual service that the system calls, and to set how its requests are logged.

Steps from Microsoft

  1. Go to Warehouse management > Setup > External Services > External service instances.
  2. On the Action Pane, select New to create an external service instance.
  3. Enter an External service instance name, a Description and the External service definition to use.
  4. On the General tab, enter the Base URL and the Authentication secret, and choose the Logging level and Log request bodies.
  5. Set Service offline to Yes only while the service is unavailable, then select Save.

Source: Microsoft Learn

Fields on the page

FieldWhat it meansTable column
External service definitionThe service definition that the instance uses.Microsoft Learn ExternalServiceDefinitionId
Base URLThe host name of the external service.Microsoft Learn BaseURL
Authentication secretThe password or shared key used to authenticate with the service.Microsoft Learn
Logging levelThe level of log entries to generate: errors only, successes and errors, or none.Microsoft Learn LoggingLevel
Log request bodiesHow much extra detail to include in log entries.Microsoft Learn RequestBodyLoggingLevel
Service offlineSet to Yes while the service is offline so that the system does not try to connect to it.Microsoft Learn Offline

Test checklist

  1. Create the instance with the service's Base URL and authentication secret, and link the definition.
  2. Link a label printer to the instance in Label print service instance.
  3. Print a label and open Request log on the instance.
  4. Check Request details show the request and an HTTP 200 response; set Service offline to Yes and check no request is sent.

Source: Microsoft Learn

Functional consultant

4Setup decisions

Setup stepRecommended value and whyDecision, common mistake and test
Set up External service instancesLogging level and Log request bodies: Successes and errorsLearn marks Successes and errors as the recommended value for both logging settings, which gives the request log the detail needed for troubleshooting.Leaving the system calling a service that is down. Set Service offline to Yes during known outages so the system doesn't wait for responses, and back to No afterwards.
Solution architect

5Design impact

Can it be undoneReversible: All instance settings can be changed at any time; they apply to requests sent afterwards. Microsoft Learn
Technical architect

6Technical

Menu itemWhsExternalServiceInstances Checked in Dynamics 365
FormWhsExternalServiceInstances Checked in Dynamics 365
TableWhsExternalServiceInstanceShown as “EXTERNAL SERVICE INSTANCES” in Record infoKey field: ExternalServiceInstanceIdChecked in Dynamics 365
Data entitiesWHSWarehouseExternalServiceInstanceEntityExternal service instances Checked in Dynamics 365
Who can open itPrivilegesMaintain warehouse external service instances WhsExternalServiceInstanceMaintainView warehouse external service instances WhsExternalServiceInstanceViewDuties WhsExternalServiceEnableInquire into warehouse operation master WMSWarehouseOperationMasterInquire
5 security rolesField Service Integration User FieldServiceIntegrationUserProduction supervisor ProdProductionSupervisorProcess engineering manager RouteProcessEngineeringManagerWarehouse planner WHSWarehousePlannerWarehouse manager WMSWarehouseManager
Checked in Dynamics 365
Roles to set it up and use itTo set it up or change itWarehouse manager WMSWarehouseManagerTo use itWarehouse planner WHSWarehousePlannerProduction supervisor ProdProductionSupervisorProcess engineering manager RouteProcessEngineeringManagerField Service Integration User FieldServiceIntegrationUserGive people one of these roles. On this system, 5 roles can open this page.Checked in Dynamics 365
Actions on the page(Action Pane without tabs): Request logChecked in Dynamics 365
Developer

7Developer

Open it by URLhttps://<your-environment>/?mi=WhsExternalServiceInstances
Integrate withWHSWarehouseExternalServiceInstanceEntity data entity Checked in Dynamics 365
Everyone

8Sources