Instance Directory Service
The Instance Directory is installed on a server and consists of a locally stored XML data file containing the instance information. This information is exposed through a network-wide discoverable Web Service, governed by a Windows Service. Since the Instance Directory serves all Case Manager applications on the network with instance information, there should only be one Instance Directory installed on a network. Applications will connect to the first Instance Directory to respond and disregard the rest. Multiple Instance Directories can consequently produce unpredictable and confusing behavior.
Installation
The Instance Directory Service installation file (setup.exe
) can be found in the CaseManagerInstanceDirectoryService folder in CaseManagerServerApps. When running this setup file you will be prompted for an installation location. The default location is the CaseManagerInstanceDirectory.
The setup installs:
- The Instance Directory Service application files
- A Windows Service called
Case Manager Instance Directory
- The XML storage file:
CaseManagerInstanceDirectory.xml
- A configuration file:
CaseManagerInstanceDirectoryService.exe.config
Network Configuration
A discoverable web service is published and used by all Case Manager applications on the network to access instance information. Upon start-up of the web service, the current machine's IP address is detected and used to publish the web service. The default port for the Web Service is TCP port 3737
. Web-Service Discovery requires an additional port: UDP port 3702
. These ports should be opened on the server's firewall for incoming connections. Although direct access to the web service would, in general, not be required, it can be accessed via the following address to verify that it is running:
http://<ipaddress>:<port>/VoyagerNetz/InstanceDirectory/Service
More on Network configuration can be found in our Technical Overview
It's important to note that discovery will only work on local networks. It makes use of a one-hop broadcasted UDP packet which will be blocked from traversing networks. Virtual Private Networks (VPNs) also block this communication. If your environment operates on such a network, you may have to use an alternative.
The Instance Directory does not rely on any database and is, therefore, extremely lightweight and easy to install. The Instance Directory data is stored in a local XML file which is located in the installation folder of the service. To secure access to the data this location (CaseManagerInstanceDirectory) should not be shared on the network; it should only be accessible through the Web Service.
Starting/Stopping the service
The Case Manager Instance Directory
Windows Service is automatically started during installation, and on start-up of the server. It can be accessed through “Services” in Windows Control Panel. The Services view shows all the installed Windows Services listed. Browse to the service named Case Manager Instance Directory
. On right-clicking, you will be able to start or stop the service.
The installed Windows Services can also be viewed in the "Services" tab of the Windows Task Manager. However, if you have trouble starting/stopping the service from the Task Manager, rather open the "Service" settings directly.