Upgrade to 10.2

Version 11

    This page outlines the upgrade steps for various ArcFM Solution applications. These are basic required upgrades and do not include configuration for new tools. If you are skipping release versions (e.g., upgrading from 10.1 to 10.2), note the following:

    • DO NOT install each release in between. Only install the version to which you're upgrading.
    • DO review the upgrade steps for each release in between the original version and the one to which you're upgrading. Perform any additional upgrade steps outlined on these pages (e.g., recommended Esri patches, Responder upgrade steps, Process Framework database upgrades, etc.).
    • DO run the Create/Update ArcFM Solution System Tables tool only once. There's no need to run it multiple times.
    • DO run the Upgrade ArcFM Solution Database tool only once. There's no need to run it multiple times.
    • DO review the What's New page for each release in between. These pages will outline the new functionality available to you.
    • DO review the Migration pages for each release in between. These pages will let you know if you need to compile custom code.

     

    What's New?

    This page describes the functionality added to the current release for all products in the ArcFM Solution suite.

     

     

    Migrate Custom Code

    This section provides a list of API changes for 10.2. Be sure to review the API changes and perform any migration steps for releases between your original version and the one to which you are upgrading.

     

    Tips

    • New ArcFM Geodatabase: If you're configuring a geodatabase to use the ArcFM Solution for the first time, follow the steps on the Configure New Geodatabase page.
    • ArcGIS/ArcSDE Note: A mixed version environment is not supported. If you are upgrading to ArcGIS 10.1, you MUST upgrade your geodatabase to ArcSDE 10.1 as well. ArcFM Errors will occur if an ArcGIS 10.1 machine attempts to access an ArcSDE 9.3 machine or an ArcGIS 9.3 machine attempts to access an ArcSDE 10.1 geodatabase.
    • Licensing Note: If you're upgrading from a release prior to 10.1.1, you must obtain new licenses for the 10.2 release. Request a new license at the Technical Support web page. Contact Schneider Electric with licensing questions. Note that 10.2 licenses can also be used with older versions of ArcFM, back to 9.2.
    • License Manager: 10.2 licenses can be used on earlier versions of License Manager, back to License Manager version 9.2.
    • Context-Sensitive Help: Context-sensitive help (What's This tool) does not work properly with Windows 7 and Windows Server 2008 R2. To resolve this issue, download from Microsoft the WinHlp32.exe file for your operating system and execute it.
    • Beware of WordPad: When editing configuration files, DO NOT use WordPad. It has been known to insert characters that can cause malformed XML.

     

    Upgrade ArcFM

    While a feature class with a join is present in the map extent, Esri bug NIM094369 causes ArcMap drawing errors when using all ArcFM and Responder trace tools, as well as those belonging to Esri’s Utility Network Analyst toolbar. When joined data is present, this bug effectively renders trace results invisible when returned as a drawing, though results can still be returned as a selection. This especially affects clients planning to implement Feeder Manager 2.0 because it requires joins on all electric feature classes.

     

    Upgrade ArcFM Geodatabase

    Applies to: All geodatabases being upgraded.

    Upgrade your geodatabase before performing any other upgrades. If you are skipping release versions (e.g., upgrading from 9.3 to 10.1), you must perform the upgrade steps for each release in between your original release and the one to which you're upgrading. The exceptions are the Create/Update ArcFM Solution System Tables and Upgrade ArcFM Solution Database tools. These need only be run once with each upgrade, regardless of whether you're skipping versions.

    1. Execute the Create/Update ArcFM Solution System Tables tool with each upgrade. The ArcFM System Tables must be located in the same schema as the SDE system tables. When running this tool, you must be connected to the geodatabase as the user who owns the .Default version. All other users must be disconnected from the database. Running this tool is required.
    2. Use the Upgrade ArcFM Solution Database button to update your geodatabase with modifications required by the latest release. This button remains enabled on the ArcFM Solution toolbar in ArcCatalog. You must be signed in as the owner of the business data to upgrade the database, and you must be connected to an editable version. This tool also requires that there be a single owner for all GIS tables. This tool also performs the following updates:
      • Adds the MARKINGUNITSOFMEASURE field model name to the Fiber Field Model Names domain. This field model name supports the new footstamp unit conversion functionality in Fiber Manager.
    3. Optional. If you are running Terminal Services, it must be running in Install Mode.
    4. Optional. When upgrading from 9.3, select the geodatabase and right click Properties. On the General tab, click Upgrade Geodatabase. In the Upgrade Geodatabase window, click OK.

     

    Upgrade ArcFM Geodatabase Manager

    Applies to: Geodatabase Manager users upgrading from a version prior to 10.1 only.

    You will need to check your GdbmConfiguration.xml file in the Bin folder of your ArcFM Geodatabase Manager install location, typically C:\Program Files (x86)\Miner and Miner\ArcFM Solution\Bin on a 64-bit system. Check for either of the following entries:

    •     <GdbmAssembly>Miner.Geodatabase, Version=9.2.0.0, Culture=neutral, PublicKeyToken={token value}</GdbmAssembly>
    •     <GdbmAssembly>Miner.Geodatabase, Version=10.1.0.0, Culture=neutral, PublicKeyToken={token value}</GdbmAssembly>

    If found in your configuration file, you need to edit the entry to read:

    •     <GdbmAssembly>Miner.Geodatabase.Engine, Version=10.1.0.0, Culture=neutral, PublicKeyToken={token value}</GdbmAssembly>

    Upgrade ArcFM Server

    Applies to: ArcFM Server users only.

    With a pair of Esri patches, ArcFM Server supports viewing (but not editing) Feeder Manager 2.0 data. These patches allow you to publish map services containing data belonging to a plug-in workspace. It is not necessary to install these Esri patches if you do not plan to view Feeder Manager 2.0 data on ArcFM Server.

    • ArcGIS Desktop QFE-102-DT-266424: You need only apply this patch to the machine you use to publish your map service.
    • ArcGIS Server QFE-102-S-266424: Apply this patch to any machine acting as a server for your map service.

     

    Upgrade Designer

    Applies to: Designer users only.

    • Geodatabase Upgrade: Perform the geodatabase upgrade steps (e.g., Upgrade ArcFM Solution Database) as discussed in the previous section.
    • Update Schema: Adds the tables required by the CU Administration tool. Be sure to login as the owner of the system tables.
    • Migrate Data: Copies the CUs in your geodatabase from the existing (blob) format and into the tables created in the Update Schema step. The data is copied, not moved.

     

     

    Upgrade Fiber Manager

    Applies to: Fiber Manager users only.

    Footstamp Unit Conversions

    Fiber optic cables' footstamp markings can be printed in different units, depending on the type of cable or the vendor. These footstamp units may be different than your map units. Fiber Manager now provides a way to specify the particular footstamp units on fiber optic cables and cable segments. This ensures correct cable length calculations when footstamps provide the source of cables' lengths.

    1. Create a new domain to hold the various unit constants:
      1. In ArcCatalog, right-click your geodatabase and select Properties.
      2. In the Domains tab, scroll to the bottom of the Domain Name list and enter a new domain. Name it whatever you like, e.g., FiberFootstampUnits.
      3. In the Domain Properties, specify Long Integer as the Field Type. Then specify Coded Values as the Domain Type.
      4. In the Coded Values section of the window, add a subset or all of the following. Make sure the coded values appear exactly as shown:

        CodeDescription
        4Yards
        5Miles
        9Meters
        10Kilometers
      5. Click OK.
    2. Create a new field on your fiber optic cable feature class (or any linear feature class) and assign it the new domain:
      1. Right-click the fiber optic cable feature class and select Properties.
      2. Scroll to the bottom of the Field Name list and enter a new field name, e.g., FootstampUnits.
      3. Set the new field's Data Type as Long Integer.
      4. In the Field Properties section of the window, assign the field the domain you created in step 1.
      5. Click OK.
    3. Assign the new MARKINGUNTISOFMEASURE field model name to the new field:
      1. Right-click the fiber optic cable feature class and select ArcFM Properties Manager.
      2. On the Field Model Names tab, scroll to and select the new field you created in step 2.
      3. Select Fiber Field Model Name from the Model Name Domain drop-down menu.
      4. In the Available list, double-click MARKINGUNITSOFMEASURE to assign it to the new field.
      5. Click OK.


    Add Additional Fields to Reports

    Six new field model names let you add one or more extra fields to most of the reports in Fiber Manager. These field model names are added to your database via the Upgrade ArcFM Solution Database tool. For more information, refer to the configuration guide help topic titled Configure Fiber Manager Reports.


    Reverse the order of rack items

    Create and assign the REVERSEORDERCHILDREN class model name to your rack table if you want the item in position 1 to appear at the bottom of the rack instead of the top within patch panel connection reports.


    Define selectable features for Patch Panel Report

    The ArcFM Solution Database Upgrade tool adds the new PATCHLOCATIONREPORTABLE class model name to your database. It's placed in the Fiber Object Class Model Name domain. You must assign it to the feature class representing patch locations. This model name enables you to select the patch location feature class when using the Patch Panel Connection Report tool.

     

     

    Upgrade Geodatabase Replication

    Applies to: Geodatabase Replication users only.

    Update Backup Copies of Existing Configuration Files

    The ArcFM installers automatically update your existing replication configuration files as described below. If you keep backup copies of these files, however, you must manually make the following changes before they can be used in Geodatabase Replication.

    Replication configuration files in 10.2 have changed in the following ways:

    • Change the assembly name from Miner.Geodatabase to Miner.Geodatabase.Engine
    • Change the version from 9.2.0.0 or 10.0.0.0 to 10.2.0

    Look toward the top of each configuration file for the code shown below. The necessary changes are in red:

    Web Service Configuration

    Web.config resides in the C:\Inetpub\wwwroot\ArcFMGDBReplicationService directory. The web service component may or may not reside on the same machine as the replication server.

    <section name="GlobalWebReplicaSection" type="Miner.Geodatabase.Replication.Configuration.GlobalWebReplicaSection, Miner.Geodatabase.Engine, Version=10.2.0, Culture=neutral, PublicKeyToken=196beceb052ed5dc" />
       
    Replication Client Configuration

    ReplicationConsole.exe.config resides in the ArcFM Solution\Bin directory on the client machines.

    <section name="GlobalClientReplicaSection" type="Miner.Geodatabase.Replication.Configuration.GlobalClientReplicaSection, Miner.Geodatabase.Engine, Version=10.2.0, Culture=neutral, PublicKeyToken=196beceb052ed5dc" />

     

     

     

    Upgrade Mobile

    Applies to: Mobile users only.

    Set Server OIDs

    This tool assigns a ServerOID to each feature in the workspace. Use the Customize menu to add this tool to the ArcFM Solution toolbar.

    • See the Event Viewer for errors logged while running the ArcFM Set Server OIDs tool. Click Applications and Services Logs > Miner.
    • This tool may not be used on an SDE database. It works only on personal (Access) and file geodatabases. If you're using Mobile, the database must be designated for field use.

     

    The ArcFM Set Server OIDs tool takes the following action on your database:

    1. It adds the ServerOid field if it does not already exist.
    2. It adds an index to the ServerOid field.
    3. It copies values from the existing ObjectID field to the new ServerOID field.
    4. It remaps relationships that were based on ObjectID to instead be based on ServerOID.
    5. For each table on which a GlobalID type field exists, the tool changes the field to be a Guid type.
    6. It adds an index to the GlobalID field if it does not exist.
    7. It disables visibility of the ServerOid and GlobalID fields.
    8. It makes ServerOid and GlobalID field editable.
    9. It allows null values for the ServerOid and GlobalID fields.


    Run the Set Server OIDs tool

    Due to limitations in the size of Personal (Access) Geodatabases, there are different methods for running the Set Server OIDs tool based on the type of initial extract database you use.

     

    File Geodatabases

    Use the following process to run the ArcFM Server OID tool on your Initial Extract database:

      1. Disable any virus-scanning software. If you use Microsoft Security Essentials, for example, follow these steps to temporarily disable real-time protection:
        1. Open Microsoft Security Essentials.
        2. Click the Settings tab.
        3. Click Real-time protection in the left pane.
        4. Uncheck Turn on real-time protection.
        5. Click Save Changes.
      2. If the ArcFM Set Server OIDs button does not appear on the ArcFM Solution toolbar, add it.
        1. Click Tools > Customize.
        2. Click the Commands tab.
        3. Click ArcFM Solution in the Categories list on the left.
        4. From the list on the right, drag the ArcFM Set Server OIDs tool to the ArcFM Solution toolbar.
        5. Close the Customize window.
      3. Open your Initial Extract geodatabase in ArcCatalog.
      4. Select the Initial Extract geodatabase and click ArcFM Set Server OIDs on the ArcFM Solution toolbar. The time required to run the tool will vary according to the size and complexity of your database.

    See the Event Viewer for errors logged while running the ArcFM Set Server OIDs tool. Click Applications and Services Logs > Miner.

    Try either of the following workarounds if you see an error similar to "Failed to add field, could not acquire schema lock!"

      • Temporarily disable Microsoft Security Essentials or any virus scan that might be running.
      • Run MMFieldExtractorServerOID.exe from the command line:

    SetServerOIDsCMD.png

      1. Delete the contents of the directory containing your geodatabase replicas associated with your Base Path. Do not delete the initial extract directory or its contents.
      2. Run ReplicationConsole.exe server to recreate the server replicas.

    Note: Client machines will receive a full download the next time they run replication.

      1. Re-enable real-time protection in Microsoft Security Essentials, or re-enable your other virus-scanning software.

     

    Personal Geodatabases

    For Personal Geodatabases, we recommend running the Set Server OIDs tool from the command line.

    While you may run ArcFM Set ServerOIDs on a personal geodatabase (*.mdb) in ArcCatalog (exactly as described in the File Geodatabase instructions above), it may cause the Personal Geodatabase to temporarily grow to surpass the 2GB size limit. You may see an error in the event log similar to this:

     

    Process failed! System.Runtime.InteropServices.COMException (0x80004005): Cannot open database. It may not be a database that your application recognizes, or the file may be corrupt.

     

    When this happens, the ArcFM Set ServerOIDs tool will fail. In this event, you have two options. Either run the Set Server OIDs tool from the command line, or compress the database and retry. To Compress and Retry, first Restart ArcCatalog. Next, right-click the personal geodatabase and select Administration > Compact Database. Run ArcFM Set ServerOIDs again. Last, you may want to compact the geodatabase again when ArcFM Set ServerOIDs has completed.

     

    Use the following process to run the ArcFM Server OID tool on your Initial Extract database:

      1. Disable any virus-scanning software. If you use Microsoft Security Essentials, for example, follow these steps to temporarily disable real-time protection:
        1. Open Microsoft Security Essentials.
        2. Click the Settings tab.
        3. Click Real-time protection in the left pane.
        4. Uncheck Turn on real-time protection.
        5. Click Save Changes.
      2. Run the Set Server OIDs tool from the command prompt:

    SetServerOIDsCMD.png

    The time required to run the tool will vary according to the size and complexity of your database.

      1. Delete the contents of the directory containing your geodatabase replicas associated with your Base Path. Do not delete the initial extract directory or its contents.
      2. Run ReplicationConsole.exe server to recreate the server replicas.

    Note: Client machines will receive a full download the next time they run replication.

      1. Re-enable real-time protection in Microsoft Security Essentials, or re-enable your other virus-scanning software.

    Upgrade Process Framework

    Run the Create Table Indices script using the Database Upgrade Tool. No new tables are added with this release.

     

     

    Upgrade Responder

    Applies to: Responder users only.

    Reminder: Responder users will need to perform the ArcFM Geodatabase upgrade steps as well.

     

    If you're implementing Responder for the first time, this section is not necessary. Follow the steps outlined in the Configure Responder section.

    • Upgrade Tables: If you have installed a previous version of Responder, execute the upgrade scripts for 10.2 as well as any releases between the current release and your original release. For example, if you have 10.0.1 SP1 and plan to upgrade to 10.2, you will need to run the scripts for 10.0.2, 10.0.3, 10.1, 10.1.1, and 10.2. This will provide the tables, views and indices necessary for Responder. Execute these scripts on your Responder database.
    • Upgrade Configuration: After installing the Responder components, run the installed batch script for each component to automatically update the various configuration files. If you are skipping releases, you must execute the batch scripts for each release between the one you started with and the one to which you're upgrading. These batch scripts that preserve your existing configuration files and append changes that support new functionality. If you are installing Responder for the first time, this step is not necessary. Each Responder component (client, server, web) has its own batch script. Just double-click it to execute. These scripts are installed at the following locations:
      • Client: Program Files (x86)\Miner and Miner\Responder\Developer Resources\[Upgrade for current release]\Config\UpgradeClient.bat
      • Server: Program Files (x86)\Miner and Miner\Responder\Developer Resources\[Upgrade for current release]\Config\UpgradeServer.bat
      • TroubleMaker: Program Files (x86)\Miner and Miner\Responder\Developer Resources\[Upgrade for current release]\Config\UpgradeTroubleMaker.bat
      • Web: C:\Inetpub\wwwroot\Responder\Developer Resources\[Upgrade for current release]\Config\UpgradeWeb.bat. If your Inetpub directory exists on drive other than C:\, you will need to modify the UpgradeWeb.bat file to point to the correct directory.

     

    There are a few cases in which you may need to manually configure these files instead of using the batch scripts:

    • The batch script fails. Some customizations to the configuration files may cause the upgrade script to fail.
    • You are starting with a release older than 9.1.2. The batch script functionality was introduced with the 9.1.2 SP1 release.

     

    If you need to update manually, be sure to back up the original configuration files before making any changes. Configuration files for the current release are installed in the following locations:

    • Client and Server: Program Files (x86)\Miner and Miner\Responder\Developer Resources
    • Web: C:\Inetpub\wwwroot\Responder\Developer Resources

     

    Copy these files from the Developer Resources folder and paste them over your original configuration files (AFTER the originals have been backed up). Configure these files with your connection information, etc.

    • If you have modified any feature class IDs, names or model name assignments, you will need to clear the FacilityTypes*.cache files from the cache on the business server. The FacilityTypes files in this directory become out of date and must be deleted manually. Follow these steps:
        1. Browse to the Cache folder in the Application Data directory for the current user on the business server (e.g., C:\Documents and Settings\[user name]\Local Settings\Application Data\Miner and Miner\Responder\Cache).
        2. In the Cache directory, select all files that start with FacilityTypes and press Delete on the keyboard.

    Cache.png