ArcFM Sync Service

Version 11

    The ArcFM Mobile Sync Service is required if you would like to take your operational maps offline.


    Please review the ArcFM Mobile for Windows Configuration Guide for system requirements before attempting to install the ArcFM Sync Service.


    Installing the ArcFM Sync Service:

    1. Click the link at the bottom of this page to download the ArcFM Sync Service installer.
    2. Double-click the downloaded .exe file to begin installation.
    3. Click Run if the Open File - Security Warning window opens.
    4. Click Install.
    5. Click Yes if the User Account Control window opens.
    6. If you do not already have Microsoft .NET Core 2.0.0 Windows Server Hosting installed, you will be prompted to install it.  Click the checkbox next to "I agree to the license terms and conditions" then click Install.  Once the install has completed successfully, click Close.  The installation of the ArcFM Sync Service will resume automatically.
    7. Click Finish.


    Upgrading the ArcFM Sync Service:

    If upgrading from a previous version of the ArcFM Sync Service, follow the steps below to ensure that you do not lose any previous configuration.

    1. Locate the Web.config file for the ArcFM Sync Service.  By default, this file is located in c:\inetpub\wwwroot\ArcFM.Mobile.SyncService. Copy this file into another location, such as your Desktop.
    2. If you have altered your ApplicationInsights.config file, you should also copy this file to another location.  By default, it is also located in c:\inetpub\wwwroot\ArcFM.Mobile.SyncService.
    3. Uninstall the previous version of the ArcFM Sync Service using the uninstall instructions below.
    4. Install the current version of the ArcFM Sync Service using the install instructions above.
    5. Once the install has completed, open the newly installed appsettings.json file in a text editor such as Notepad or Notepad++.  You will need to copy settings from the web.config file which you copied in step 2.  Be careful not to alter the format of the appsettings.json file.  Copy the following settings:
      1. From web.config, copy the value from <add key="Microsoft.ServiceBus.ConnectionString" value=”!!! REQUIRED !!!”/> into "Microsoft.ServiceBus": { "ConnectionString": "!!! REQUIRED !!!"}
      2. Copy the value from <add key=”OrganizationName” value=”!!! REQUIRED !!!”/>  into "Organization": { "Name": "!!! REQUIRED !!!" }.
      3. Copy the value from <add key="NetworkFileStorage.StorageLocation" value = “!!!! REQUIRED !!!”/> into "NetworkFileStorage": {    "StorageLocation": "!!! REQUIRED !!!".  You will need to add double slashes.  For example, “c:\mobile\sync\replicas” would become “c:\\mobile\\sync\\replicas”.
      4. If you have changed the value in <add key="NetworkFileStorage.WebsiteAddress" value="https://{COMPUTERNAME}.{USERDNSDOMAIN}/ArcFM.Mobile.SyncService" />, copy that value into "WebsiteAddress": “https://{COMPUTERNAME}.{USERDNSDOMAIN}/ArcFM.Mobile.SyncService”.
      5. If your map services are federated Portal for ArcGIS or ArcGIS Online, copy the values from <add key="ArcGISServer.User.Username" value="" /> and <add key="ArcGISServer.User.Password" value="" /> into "ArcGISServer": { "Username": "", "Password": "".
    6. You will need to create a new type of API key for the on-premises sync service to use to report its status.  To do this, follow the following steps.
      1. Make sure you have the latest version of the ArcFM Solution Center.  You will need version 1.2 or later.  If the ArcFM Solution Center has not automatically updated, you can download the latest version from
      2. After the install is complete, open the ArcFM Solution Center and log into your organization as a user with administrative privileges.
      3. Click on “User Management” in the left pane.
      4. Click on “API Keys” on the top pane.
      5. Click the “Add New” button located in the upper left corner of the API Keys window.
      6. Enter a name for your new API Key.  Schneider Electric suggests a name such as “[OrganizationName] Sync Service”.
      7. Click the “Add Role” button.
      8. Check the box next to “Monitoring.Reporter” and click the “Apply” button.
      9. Click the “Save” button located in the lower right corner.
      10. Copy the Client ID into "ClientId": "!!! REQUIRED !!!".
      11. Copy the Client Secret into "ClientSecret": "!!! REQUIRED !!!".  It is important that you do not close the ArcFM Solution Center until you have done this.  The ClientSecret is only displayed once.
    7. If you altered the ApplicationInsights.config file, copy the value from the key “"Microsoft.AI.InstrumentationKey"” into "ApplicationInsights": { "InstrumentationKey": ""}.


    Uninstalling the ArcFM obile Sync Service:

    1. Using Windows Control Panel > Programs and Features, select ArcFM Mobile Sync Service 1.x.
    2. Choose Uninstall and follow the prompts to remove ArcFM Sync Service.


    For system requirements, see GIS - Supported Versions - ArcFM Mobile Services, Portal, and ToolsPlease note that as of version 1.3.1, the ArcFM Mobile Sync Service requires Microsoft .NET 4.7.


    Important Note for Windows Server 2008 Users: Beginning with version 1.3.1, the ArcFM Mobile Sync Service requires that Service Pack 1 be installed on Windows Server 2008 machines.  Service Pack 1 can be downloaded from Microsoft here.


    Please visit the ArcFM Mobile Configuration Guide for post installation and configuration instructions.


    Download File

    ArcFM Mobile Sync Service 1.3.1