{"id":44724,"date":"2026-09-10T00:29:09","date_gmt":"2026-09-09T16:29:09","guid":{"rendered":"https:\/\/oihelp.corporate.ifs.com\/help\/?page_id=44724"},"modified":"2026-09-10T03:26:18","modified_gmt":"2026-09-09T19:26:18","slug":"edge-host","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/connecting-your-data\/edge-host\/","title":{"rendered":"Edge Hosts"},"content":{"rendered":"\n<p class=\"intro-text\">An Edge Host allows IFS OI Server Adaptors to be installed remotely from the main IFS OI Server machine, and is primarily used to allow IFS OI Explorer to get data securely from an on-premise datasource.<\/p>\n<p class=\"intro-text\">This is done without the need for a VPN or opening of a port into the on-premise network. Components installed into the on-premise environment make calls to the cloud hosted machines, and then all bi-directional communications are made via this connection.<\/p>\n<p class=\"intro-text\">In most instances the Edge Host will be installed on-premise and the IFS OI Server in the cloud.<\/p>\n<p class=\"left-bar\">This article applies to all supported IFS OI versions. Where installation or configuration steps differ for IFS Cloud versions, separate instructions are provided.<\/p>\n<hr \/>\n<h2 class=\"page-subheading\">Installing the Edge Adaptor<\/h2>\n<p class=\"intro-text\">This section describes how to do the initial installation and set up permissions for the user identity that the remote host will connect as.<\/p>\n<h3>1. In Server Management<\/h3>\n<p class=\"intro-text\">1. Open IFS OI Server Management and select the <strong>Security<\/strong> icon on the left.<\/p>\n<p class=\"intro-text\">2. Create a Server Admin role that also has access to the Edge Data resource (you can also use an existing role for this). The role must have the Server Admin module privilege and the Edge Adaptor 'Connect As' privilege.<\/p>\n<p><a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/server-privileges.png\" rel=\"lightbox-0\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone  wp-image-72573\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/server-privileges.png\" alt=\"\" width=\"318\" height=\"114\" srcset=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/server-privileges.png 641w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/server-privileges-600x215.png 600w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/server-privileges-150x54.png 150w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/server-privileges-48x17.png 48w\" sizes=\"auto, (max-width: 318px) 100vw, 318px\" \/><\/a><\/p>\n<p><a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/edge-adaptor-connect-as.png\" rel=\"lightbox-1\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone  wp-image-72574\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/edge-adaptor-connect-as.png\" alt=\"\" width=\"318\" height=\"55\" srcset=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/edge-adaptor-connect-as.png 532w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/edge-adaptor-connect-as-150x26.png 150w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/edge-adaptor-connect-as-48x8.png 48w\" sizes=\"auto, (max-width: 318px) 100vw, 318px\" \/><\/a><\/p>\n<p class=\"intro-text\">3. Assign appropriate users to that role. Note that these users will also be given full access to IFS OI Server Management.<\/p>\n<p class=\"intro-text\">4. Click the <strong>Connections<\/strong> icon on the left, and then click <strong>Edge Hosts<\/strong>.<\/p>\n<p><a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/Connections-edge-hosts.png\" rel=\"lightbox-2\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone  wp-image-72572\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/Connections-edge-hosts.png\" alt=\"\" width=\"235\" height=\"259\" srcset=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/Connections-edge-hosts.png 437w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/Connections-edge-hosts-136x150.png 136w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/Connections-edge-hosts-44x48.png 44w\" sizes=\"auto, (max-width: 235px) 100vw, 235px\" \/><\/a><\/p>\n<p class=\"intro-text\">5. Click <strong>Create New Edge Host<\/strong>. On the Edge Host page configure the following.<\/p>\n<ul class=\"intro-text\">\n<li class=\"intro-text\"><strong>Name<\/strong>: A name to identify the Edge Host (e.g. EdgeHostName). <br \/>\n<em>This name must match the one configured in the <strong>hostconfig.xml<\/strong> file on the Edge Host machine<\/em>.<\/li>\n<li class=\"intro-text\"><strong>Description<\/strong>: Further details to identify the Edge Host and the type of datasources it supports.<\/li>\n<li class=\"intro-text\"><strong>Preshared<\/strong> <strong>Key<\/strong>: A custom user-defined key that the Data Broker will use to connect to this Edge Host. <br \/>\n<em>This key must match the one configured in the <strong>hostconfig.xml<\/strong> file on the Edge Host machine.<br \/>\n<\/em><\/li>\n<li class=\"intro-text\"><strong>Assigned<\/strong> <strong>Datasources<\/strong>: The datasources that this Edge Host will support. An Edge host can support multiple datasources, but a datasource can only be assigned to one Edge Host.<\/li>\n<li><strong>Log Level:<\/strong> The log level that this Edge Host will report logs up to. E.g. Verbose will report all logs, where as Trace will report all logs up to Trace but not Debug and Verbose.<\/li>\n<\/ul>\n<p class=\"note\">Note: A datasource cannot be assigned to multiple Edge Hosts. If a datasource is disabled in the dropdown, it has already been assigned to another Edge Host.<\/p>\n<h3>2. On the Edge Host<\/h3>\n<p class=\"intro-text\">Install the IFS OI Explorer Edge Adaptor Host.<\/p>\n<p class=\"intro-text\">1. Double-click IFS OI Explorer Edge Host &lt;version&gt; Setup.msi.<\/p>\n<p class=\"intro-text\">2. At the initial setup screen, click <strong>Install<\/strong>. The installer prepares the setup, and then displays the <strong>Welcome<\/strong><span style=\"font-family: 'Segoe UI', Arial, sans-serif;\"> page.<\/span><\/p>\n<p class=\"intro-text\">3. Click <strong>Next<\/strong>.<\/p>\n<p class=\"intro-text\">4. In the <strong>Custom Setup<\/strong> screen, choose the adaptor that you want the Edge host to support. (e.g. PHD). This will deploy the necessary adaptor dependencies and infrastructure. Note: Before installing any adaptor, make sure you have the required dependencies installed.<\/p>\n<p><a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/edge-host-setup.png\" rel=\"lightbox-3\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone  wp-image-72578\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/edge-host-setup.png\" alt=\"\" width=\"448\" height=\"347\" srcset=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/edge-host-setup.png 766w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/edge-host-setup-600x464.png 600w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/edge-host-setup-150x116.png 150w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2026\/08\/edge-host-setup-48x37.png 48w\" sizes=\"auto, (max-width: 448px) 100vw, 448px\" \/><\/a><\/p>\n<p class=\"intro-text\">5. Click <strong>Next<\/strong>, and then click <strong>Install<\/strong>.\u00a0The installation will usually only take a few seconds.<\/p>\n<p class=\"intro-text\">6. When the installer has finished, click <strong>Finish<\/strong>.<\/p>\n<p class=\"intro-text\">7. At the Setup Successful message, click <strong>Close<\/strong>.<\/p>\n<p class=\"intro-text\">8. Open Windows Services and start the IFS OI<strong>\u00a0Edge Host service<\/strong>.<\/p>\n<hr \/>\n<h2 class=\"page-subheading\">Edge Host Configuration File<\/h2>\n<p class=\"intro-text\">This section describes how to edit the configuration file.\u00a0The default installation will register the Host as a Windows service and use the default configuration path. The configuration file needs to be customised to your environment.\u00a0<\/p>\n<p class=\"intro-text\">As part of the setup process:<\/p>\n<ol class=\"intro-text\">\n<li>Copy the configuration file, <strong>hostconfig-sample.xml<\/strong>, to the location: <em><em>%ProgramData%\\P2 Energy Solutions\\Edge Host\\.\n<p><\/em><\/em>For IFS OI Cloud versions, copy the configuration file to: <em><em>%ProgramData%\\IFS AB\\Edge Host\\.<\/em><\/em><em><em><br \/>\n<\/em><\/em><\/li>\n<li>Rename the file to: <strong>hostconfig.xml<\/strong><\/li>\n<li>Edit the file to suit your environment.\u00a0Pay particular attention to:\n<ul class=\"intro-text\">\n<li><strong>ServerFqdn<\/strong><\/li>\n<li><strong>EdgeHostName<\/strong><\/li>\n<li><strong>PreSharedKey<\/strong><\/li>\n<\/ul>\n<\/li>\n<li>After editing, open Windows Services and restart the IFS OI<strong>\u00a0Edge Host service<\/strong>.<\/li>\n<\/ol>\n<p class=\"intro-text\">The sample Edge Host configuration file, hostconfig-sample.xml, needs to be modified to suit your particular environment.<\/p>\n<table style=\"width: 100%; border-collapse: collapse;\">\n<tbody>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 9.8959%;\">MaxConcurrentConnectionsPerHost<\/td>\n<td style=\"width: 89.9999%;\">The maximum number of connections that can be made simultaneously to the host Data Broker. Default: 32<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 9.8959%;\"><strong>ServerFqdn<\/strong><\/td>\n<td style=\"width: 89.9999%;\">The fully-qualified hostname for the host Data Broker.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 9.8959%;\">SecurityFqdn<\/td>\n<td style=\"width: 89.9999%;\">The fully-qualified hostname for the host Security authentication service. It is normally not necessary to modify this value from a null element.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 9.8959%;\">ApiPort<\/td>\n<td style=\"width: 89.9999%;\">The port the host server API is running on; must match the WebPort setting in IFS OI Server. Default: 443<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 9.8959%;\">ApiAlias<\/td>\n<td style=\"width: 89.9999%;\">\n<p>The API alias for the host server; must match the ServiceRouteAlias setting in IFS OI Server. Default: P2.Server<\/p>\n<p class=\"note\">Note: For IFS OI Cloud versions, the default value is oi.core<\/p>\n<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 9.8959%;\">MessagePort<\/td>\n<td style=\"width: 89.9999%;\">The port the host server notification channel is running on; must match the MessagePort setting in IFS OI Server. Default: 8883<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 9.8959%;\">MessageCacheDirectory<\/td>\n<td style=\"width: 89.9999%;\">\n<p>The path on disk the message bus should use to store pending messages; serves the same function as the MessageCacheDirectory setting in IFS OI Server, <em>serverconfig.xml<\/em>, but does not have to be identical.<\/p>\n<p class=\"note\">Note: For IFS OI Cloud versions, this configuration setting is no longer required.<\/p>\n<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 9.8959%;\">SecurityAlias<\/td>\n<td style=\"width: 89.9999%;\">The Security alias for the host server. It is normally not necessary to modify this value from a null element.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 9.8959%;\"><strong>EdgeHostName<\/strong><\/td>\n<td style=\"width: 89.9999%;\">The name of the Edge Host for which this configuration applies. This must match a known Edge Host name in the host server Data Dictionary.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 9.8959%;\"><strong>PreSharedKey<\/strong><\/td>\n<td style=\"width: 89.9999%;\">The Pre-Shared Key corresponding to the named Edge Host.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 9.8959%;\">TimeoutSeconds<\/td>\n<td style=\"width: 89.9999%;\">The maximum amount of time in seconds that web-based operations should be allowed for completion. Default: 3600<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 9.8959%;\">MaxRetries<\/td>\n<td style=\"width: 89.9999%;\">The maximum number of times web-based operations should be attempted before being abandoned. Default: 3<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 9.8959%;\">RetryDelaySeconds<\/td>\n<td style=\"width: 89.9999%;\">The amount of time in seconds between attempts at performing a given web-based operation. Default: 3<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 9.8959%;\">MessageLoggingEnabled<\/td>\n<td style=\"width: 89.9999%;\">If True, enable message transport logging. While potentially useful for diagnosing issues, enabling this option has a performance impact. Default: False<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 9.8959%;\"><strong>&lt;Username&gt;&lt;\/Username&gt;<\/strong><br \/>\n<strong>&lt;Password&gt;&lt;\/Password&gt;<\/strong><\/p>\n<p style=\"text-align: left;\">OR<\/p>\n<p><strong>&lt;UseImplicitAuthentication\/&gt;<\/strong><\/p>\n<\/td>\n<td style=\"width: 89.9999%;\">Authentication is required for a user who is in a role that has the Edge Data privilege. <br \/>\nFor a Forms-authenticated user:<br \/>\n<em>&lt;Username&gt;&lt;\/Username&gt;<\/em><br \/>\n<em>&lt;Password&gt;&lt;\/Password&gt;<\/em><\/p>\n<p>Or to use the Windows account that the service is running under:<br \/>\n<em>&lt;UseImplicitAuthentication\/&gt;<\/em><\/p>\n<p>If both kinds of authentication are specified, implicit authentication takes precedence.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 9.8959%;\">LocalHostingPort<\/td>\n<td style=\"width: 89.9999%;\">\n<p>The local TCP port used for loopback communication between adaptor host processes and the Edge Host. A SSL certificate must be bound to this port.<br \/>\nRefer to the examples using netsh in the sections 'Get a certificate's thumbprint' and ' Bind an SSL certificate to a port number' in Microsoft's 'How to: Configure a Port with an SSL Certificate' article. The port number used should be the LocalHostingPort number. Default: 443<\/p>\n<p class=\"note\">Note: For IFS OI Cloud versions, this configuration setting is no longer required.<\/p>\n<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 9.8959%;\">DataIngestorDisable<\/td>\n<td style=\"width: 89.9999%;\">If True, this instance will not participate in Data Cache ingestion. This should only set to False for *one* running instance per defined Edge Host, or data ingestion will be duplicated. Default: True<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 9.8959%;\">DataCacheDirectory<\/td>\n<td style=\"width: 89.9999%;\">Location where temporary data cache files are stored.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<hr \/>\n<h2 class=\"page-subheading\">Multiple Edge Hosts<\/h2>\n<p class=\"intro-text\">Multiple Edge Host instances can be run on the same system at the same time. Each instance requires its own configuration file and use of the command line option:<\/p>\n<p class=\"intro-text\">-config:\"path_to_file\"<\/p>\n<p class=\"intro-text\">to point to its configuration file.\u00a0<\/p>\n","protected":false},"excerpt":{"rendered":"<p>An Edge Host allows IFS OI Server Adaptors to be installed remotely from the main IFS OI Server machine, and is primarily used to allow IFS OI Explorer to get data securely from an on-premise datasource.<\/p>\n<p class=\"continue-reading-button\"> <a class=\"continue-reading-link\" href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/connecting-your-data\/edge-host\/\">Read more<i class=\"crycon-right-dir\"><\/i><\/a><\/p>\n","protected":false},"author":1,"featured_media":70251,"parent":3649,"menu_order":7,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":"","_members_access_role":[],"_members_access_error":""},"categories":[11],"tags":[98,1170,1167,1168,1169],"class_list":["post-44724","page","type-page","status-publish","has-post-thumbnail","hentry","category-tutorial","tag-adaptors","tag-cloud","tag-edge","tag-host","tag-remote-adaptor","Product-srv"],"_links":{"self":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/44724","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/comments?post=44724"}],"version-history":[{"count":32,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/44724\/revisions"}],"predecessor-version":[{"id":72583,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/44724\/revisions\/72583"}],"up":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/3649"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media\/70251"}],"wp:attachment":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media?parent=44724"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/categories?post=44724"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/tags?post=44724"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}