Currently many ROAD clients are only usable in combination with DPE. On this page, we will show you how to link DPE to them.

Create ROAD Clients' Base Configuration

Import the sample parameter file shipped with the ROAD clients

The ROAD client applications ship with each a sample .par file (ROAD_Admin.par, InstaRecorder.par,  ROAD_Scheduling.par) in the doc/ folder which contains the base configuration for each ROAD client.
Import this parameter file into the Global\Default space in DPE Parameters.

Your DPE Parameters should look like this (folder named according to the client):

Configure which ROAD Service(s) the ROAD clients should connect to

This parameter is mandatory for each ROAD client which is installed: Parameter location is ROAD_Admin\ROADServiceList or ROAD_Scheduling\ROADServiceList (note InstaRecorder currently supports only one ROAD Service via parameter RoadServiceUrl)

ROADServiceList: example

[
  {
    "name": "My ROAD Service",
    "value": "https://my-road-service.internal.com:11005",
    "selected": true
  }
]
YML
  • name is the human-readable name for your ROAD Service
  • value is the URL (including protocol and port) of where the ROAD client is hosted
  • selected should be set to true to select your default or favorite ROAD Service

In most environments, we expect this list to contain only one ROAD Service. In case multiple ROAD Services are configured, a ROAD Service selector will appear in the top bar in the ROAD client application.

Better be secure!

Both HTTP and HTTPS connections are supported, HTTPS being recommended in most cases.

Add the link to ROAD client in DPE

Import the sample parameter file shipped with the ROAD clients

The ROAD Admin application ships with a ROAD_Admin_Content_Manager_link.par which contains the base configuration for configuring Content Manager to display a link to ROAD Admin.
The ROAD Scheduling application ships with a ROAD_Scheduling_Content_Manager_link.par which contains the base configuration for configuring Content Manager to display a link to ROAD Scheduling.

Import the parameter file into the Global\Default space in DPE Parameters.

Your DPE Parameters should look like this:


Here is the general DPE documentation on how to configure this: Open Link in New Tab

Configure the URL of ROAD Client

In the Config key, replace <ROAD Admin URL> to the full URL where ROAD client is hosted:

ContentManager \ Menu \ ROADSCheduling \ Config : example

{
  "Url": "http://my-road-admin.internal.com:8080/",
  "AuthMode": "DpeToken"
}
YML
  • Url is the URL (including protocol and port) of where the ROAD Admin client is hosted
  • AuthMode should be set as "DpeToken". This way the authentication and authorization will be set when clicking on the link in DPE's menu

This configuration is currently mandatory for ROAD Admin and ROAD Scheduling! Currently these ROAD clients only supports authentication through DPE Token, so ROAD Admin needs to be launched through DPE to work.

Further Configuration

For InstaRecorder there's more Digas configuration options described in sub-page Configure InstaRecorder.