Configuring the user-specific endpoints file

The best way to configure a server endpoint that locates your own Esri server is through the Analyst's Notebook user interface. However, the information is added to the user-specific ServerEndpoints.config file, which you can edit by hand.

About this task

The user-specific file is in XML format. You can use a simple text editor such as Notepad, but a dedicated XML editor is better. Badly formed XML stops the product from working.

Note: If you want to change the default tokenLifespan attribute value of an endpoint configured through the user interface, you can do this only by editing the ServerEndpoints.config file manually.

Procedure

To add details of your own server endpoints to the user-specific ServerEndpoints.config file:
  1. Copy the following endpoint template code:
    <endpoint name="YourServiceName"
              binding="basicHttpBinding"
              bindingConfiguration="arcGisHttpBinding"
              address="http://your server IP address/ArcGIS/services"
              contract="i2.Mapping.Esri.ArcGISModule.Proxy.ServiceCatalogPort"/>
  2. Paste this template code inside the <client> element in the file.
  3. Replace the name attribute value (YourServiceName) with a name that is unique within the configuration file.
  4. Replace the address attribute value (http://your server IP address/ArcGIS/services) with the URI for your Esri server.
  5. If your server uses authentication, change the bindingConfiguration attribute value to the appropriate binding for your security type. The bindings are listed at the bottom of the server endpoints file. You must match the bindingConfiguration value to the name attribute value of the appropriate binding.
  6. If the server uses token-based security with a proxy page, add the following XML with the appropriate URI:
    <arcGisAuthentication>
      <tokenAuthentication>
        <serverTokenSecuredEndpoints>
          <serverTokenSecuredEndpoint
              endpointName="MyServerTokenSecuredEndpoint"
              proxyPageUri="http://myservername/arcgis_proxy/arcgis_proxy/proxy.ashx" />
        </serverTokenSecuredEndpoints>
      </tokenAuthentication>
    </arcGisAuthentication>

    The endpointName attribute value must match the name attribute value of its associated endpoint. The proxyPageUri attribute value must be the full address of the proxy page.

  7. If the server uses token-based security without a proxy page, add the following XML to the configuration file:
    <arcGisAuthentication>
      <tokenAuthentication>
        <clientTokenSecuredEndpoints>
          <clientTokenSecuredEndpoint
              endpointName="MyClientTokenSecuredEndpoint"
              tokenLifespan="60" />
        </clientTokenSecuredEndpoints>
      </tokenAuthentication>
    </arcGisAuthentication>

    The endpointName attribute value must match the name attribute value of its associated endpoint. The tokenLifespan attribute value must be within the range that the server specifies, and must be expressed in minutes.

    Note: New tokens are typically requested on behalf of the user before an existing token expires.
  8. Save and close the file, and then restart Analyst's Notebook.

What to do next

You can add as many server endpoints as you need.

Tip: To remove unnecessary servers from the user interface list, you can remove the Esri demonstration server endpoints from the preinstalled server endpoints file. This is the portion of the file that you remove:
<endpoint name="EsriDemoBaseMapProvider"
          binding="basicHttpBinding"
          bindingConfiguration="arcGisHttpBinding"
          address="http://services.arcgisonline.com/ArcGIS/services/"
          contract="i2.Mapping.Esri.ArcGISModule.Proxy.ServiceCatalogPort"/>
<endpoint name="EsriDynamicMaps"
          binding="basicHttpBinding"
          bindingConfiguration="arcGisHttpBinding"
          address="http://serverapps.esri.com/ArcGIS/services"
          contract="i2.Mapping.Esri.ArcGISModule.Proxy.ServiceCatalogPort"/>
<endpoint name="EsriDemoRouting"
          binding="basicHttpBinding"
          bindingConfiguration="arcGisHttpBinding"
          address="http://tasks.arcgisonline.com/ArcGIS/services/"
          contract="i2.Mapping.Esri.ArcGISModule.Proxy.ServiceCatalogPort"/>
<endpoint name="DriveTimes"
          binding="basicHttpBinding"
          bindingConfiguration="arcGisHttpBinding"
          address="http://sampleserver3.arcgisonline.com/ArcGIS/services"
          contract="i2.Mapping.Esri.ArcGISModule.Proxy.ServiceCatalogPort"/>