Tech Paper - ArcFM Server Installation: 9.3.1 SP2 and earlier

Version 2

    Obsolete at version 10.0.1. ArcFM Server no longer supports web applications built using ADF.



    ArcFM Server enhances the ArcGIS Server environment by providing utility specific functionality. Depending on your load requirements, ArcGIS Server can be installed with all the components residing on a single machine or deployed across several machines. The ArcFM Server environment can be scaled in a similar fashion. Figure 1 depicts a distributed installation of ArcGIS Server (see Configuring a Distributed Installation of ArcGIS Server (Windows) An Esri Technical Paper – April 2006).



       Figure 1, ArcFM Server


    Choosing a Configuration

    The design of the ArcFM Server configuration is determined by the design of your ArcGIS Server configuration. The ArcFM Server installation has corresponding components for each of the ArcGIS Server installation components.

    The ArcFM Server components (Figure 2) – specifically the Server Object Containers – must be installed on any machine that hosts ArcGIS Server Object Containers (SOC). The Developer Resources component installs the interops and .NET assemblies.



       Figure 2, Installation Components


    The Web Applications – specifically the Web Services – must be installed on the machine that hosts the web server. The ArcFM Viewer component installs ArcFM Viewer for ArcGIS Server which offers a wealth of tools for viewing and navigating your GIS data through a web browser. The ArcFM Server Manager Integration section installs the ArcGIS Server Manager template. This template allows you to build out-of-the-box web sites for use with ArcFM Server. This component should be installed on the web server.



    Once ArcGIS Server has been successfully installed and configured, you are ready to install ArcFM Server. The ArcFM Server Setup wizard displays a dialog box that allows you to choose which ArcFM Server components to install. Each machine that hosts an ArcGIS Server component should also have the corresponding ArcFM Server component.


    The ArcFM Server components correspond with the following ArcGIS Server components:


    ArcFM ServerArcGIS Server
    Server Object Container (SOC)Server Object Container (SOC)
    Developer ResourcesOptional. Install on web application development machines
    Web ServicesWeb Server
    ArcFM ViewerWeb Server
    ArcFM Server Manager IntegrationOptional. Install on the Web Server





       Figure 3, ArcFM Server Installer


    The ArcFM Server Object Container (SOC) components must be installed on the same machine as ArcGIS Server SOC components. ArcFM Server requires installation of the ArcGIS Server Web Application Developer Framework Runtime component on all SOC machines (Figure 4). The developer resources should be installed on the web application development machines. The Web Applications component should be installed on the web server machine.



       Figure 4, ArcGIS Server Installer


    The ArcFM SDK is a separate installer that contains ArcFM Server Visual Studio 2008 templates as well as online documentation for implementing and customizing your ArcFM Server application. The ArcFM SDK should be installed on web application development machines.



    The ArcFM Desktop Administrator displays the number of ArcFM Server licenses available. A license is necessary for each ArcFM SOC installation. If you have installed SOCs on multiple machines, you will need multiple ArcFM Server licenses. The steps for enabling a license for a map service are discussed below.


    You will need to install the License Manager on each SOC machine. Using the Desktop Administrator, point to the appropriate server in the Floating License Server field to retrieve the ArcFM Server license.



       Figure 5, Desktop Administrator


    Any existing map services require an ArcFM Server license to be enabled using a Server Object Extension (SOE). Any map services that exist at the time of the ArcFM Server installation will automatically have the ArcFM Server License enabled. Any new map services that are added after the installation will require the ArcFM Server License to be manually enabled. This can be done in ArcCatalog by following these steps:

    1. In ArcCatalog, expand GIS Servers and the machine on which your service(s) reside.
    2. In order to modify the ArcFMMapServer option, the service must be stopped. Right-click the service and select Stop.
    3. Right-click the stopped service and select Service Properties.
    4. On the Capabilities tab, scroll to the bottom of the list of checkboxes to find ArcFMMapServer.
    5. Select the ArcFMMapServer checkbox to enable. Uncheck it to disable.
    6. Click OK.
    7. Right-click the service and select Start.


       Figure 6, Map Service Properties


    Alternatively the ArcFM Server Licensing can be run as an executable from the command line. The Miner.Server.AddLicensingSOE.exe is an executable file that resides in the \Program Files\Miner and Miner\ArcFM Solution\Bin directory. Use this executable to add the licensing extension and enable it for map services.

    1. Open a command prompt and change the directory to Program Files\Miner and Miner\ArcFM Solution\Bin.
    2. Enter the following and press Enter.     
      Miner.Server.AddLicensingSOE.exe /a



    If you wish to delete the licensing extension from the server, enter the following and press Enter:

    Miner.Server.AddLicensingSOE.exe /d


    Configuration Files

    ArcFM Viewer for ArcGIS Server requires a small amount of configuration. Modify Web.config to enable ArcFM Viewer for ArcGIS Server. The Web.config file sets the connection to the web server.


    Multiple Map Resources: If you wish to access multiple map services in a single map, you will need to first set the map extent for each map resource. All map resources must have the same map extent.

    1. Browse to C:\Inetpub\wwwroot\ArcFMViewer and open the Web.config file installed at this location. This file can be opened with any text editor (e.g., Notepad).
    2. Search the Web.config file for the lines of XML displayed below:

      <service name="MapService1" resourceDefinition="(default)@MapService1"
      dataSourceDefinition="MapServer" dataSourceType="ArcGIS Server Local" dataSourceShared="true" />
      <service name="MapService2" resourceDefinition="(default)@MapService2"
      dataSourceDefinition="MapServer" dataSourceType="ArcGIS Server Local" dataSourceShared="true" />
      <service name="MapService3" resourceDefinition="(default)@MapService3"
      dataSourceDefinition="MapServer" dataSourceType="ArcGIS Server Local" dataSourceShared="true" />

    1. ArcFM Server allows you to reference multiple map resources in a single map. Each map resource must have its own tag. By default, three are listed. If you have fewer, delete the extras. You may create more than three map resource connections by creating additional lines of XML.
    2. Fill in the values (highlighted in yellow). Replace both instances of MapService1 (2, 3) with the name of the ArcGIS Server Map Service. Replace MapServer with the name of the ArcGIS Server machine.
    3. Search the Web.config file for the following line of XML:
        <identity impersonate="true" userName="mydomain\myusername" password="mypassword" />
    1. Enter your Windows user name (including the domain) and password. You may encrypt the password using Esri’s Add ArcGIS Identity option in Visual Studio. Refer to Esri documentation for more information.
    2. You may set the amount of time that must pass before an Esri Web ADF session times out. This step is optional. Look for the following line of XML and set the timeout value to the number of minutes after which the session times out.
            <sessionState timeout="30" />
    1. Save and close Web.Config.
    2. If you set the timeout value for an Esri Web ADF session (step 6), then you must complete the following steps. If you did NOT configure this optional step, your configuration is complete.
    3. Browse to and open default.aspx. It is located here: C:\Inetpub\wwwroot\ArcFMViewer\default.aspx.
    4. Look for the following line (it's toward the bottom):
          <script language="javascript" type="text/javascript"> var maximumLapseTime = 30; </script>
    1. This value overrides Esri's maximumLapseTime value for Web ADF sessions only. Modify this value. It must match or be less than the timeout value in the     Web.config file.
    2. Save and close default.aspx.