ArcFM Connectivity Evaluator (ACE)

The ArcFM Connectivity Evaluator (ACE) tool is a separate application from Solution Center. Its core function is to test and verify connectivity to ArcFM services and, depending on the application, connectivity to Azure Service Bus. This is a crucial prerequisite prior to performing Solution Center configuration or any XI series app configuration, given that you need connectivity for the configuration to work.

The ACE tool is intended to help you test connectivity prior to installation, during implementation, and any point in the future when you need to verify or troubleshoot connections to the necessary services.

Download the ACE Installer

The ACE installer can be downloaded via the ArcFM Solution Center article on myArcFM. You must have a myArcFM account to log in and download apps.

Because the ACE tool is testing connectivity, it only works after your company’s tenant is created.

Verify Core Outbound URL Access

Verifying access to core outbound URLs is extremely helpful during the very early stages of your implementation. This verification includes the ability to access core ArcFM Services, Auth0, and the Tenancy Service itself. Access to these core services is a prerequisite for essentially any other configuration or implementation step.

To verify access, follow these steps:

1. Launch the ACE tool. To verify core outbound URLs, you only need the ACE tool and tenant ID. To verify access to other services (more info provided below) and to Azure Service Bus, the ACE tool needs to be installed on the same machine as the actual application.

   IMPORTANT: Verifying core outbound URL access can happen on any machine. The ACE tool does not necessarily need to be installed on the same machine that contains the actual XI series application.

2. If this is the first time you have launched the tool, “Please enter your organization’s name” then click Submit.

   

   You don’t need to log in to check core outbound URLs. Refer to the Firewall Rules for Ports topic for more information.

3. Click the View <yourtenantid> Allowlist button.

   

   
   

   The interface displays plugin buttons for All Services and Login Info.

   

4. 1. To view the required URLs for all services, click All Services. To generate a PDF of service URLs, click Open Services Report. This is a great way to share the URLs that require allowlisting.

      

      NOTE: Reports are saved in the directory C:\Users\user_name\AppData\Local\ArcFMConnectivityEvaluator\app-version#\Reports.

   2. To test access to the URLs, click the Login Info button.

      Click the Test All “play” button to test every service listed on the right under Not Tested, all of which are required to log in. You can test individual services by selecting one under Not Tested.

      

      
      

      As mentioned above, testing access to other services and to Azure Service Bus requires that the ACE tool be installed on the same machine as the XI series application you want to run.

      After running a test, the application displays the test results along with an HTTP status code.

      The following table includes a description of the possible result codes, whose standard descriptions are taken from the protocols established by the Internet Engineering Task Force (IETF):

      Code	Result	Description	Troubleshooting
      200	OK	The request has succeeded. The information returned with the response is dependent on the method used in the request	The server responded as expected.  The service is functioning normally.
      302	Found	The requested resource resides temporarily under a different Uniform Resource Identifier (URI). Since the redirection might be altered on occasion, the client should continue to use the Request-URI for future requests. This response is only cacheable if indicated by a Cache-Control or Expires header field.	Most likely a misconfigured service URL.  Copy test results, contact support, and include copy of test results.
      400	Bad Request	The request could not be understood by the server due to malformed syntax. The client should not repeat the request without modifications.	Problem with the ACE tool. Update to current version and try again.
      401	Unauthorized	The request requires user authentication.	Problem with ACE tool not sending an appropriate authentication header.  Update to current version and try again.
      403	Forbidden	The server understood the request, but it is refusing to fulfill it.	Misconfigured service permissions.  Make note of the service being tested.  Copy test results, contact support, and include copy of test results.
      404	Not Found	The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.	Misconfigured service endpoint.  The service has been removed, is down, or customer has not been configured for service. Copy test results, contact support, and include copy of test results.
      407	Proxy Authentication Required	Indicates that the client must first authenticate itself with the proxy.	Customer has proxy in use and user must authenticate to proxy first before connecting to ArcFM services.  Copy test results, contact support, and include copy of test results.
      408	Request Timeout	The client did not produce a request within the time that the server was prepared to wait. The client may repeat the request without modifications at any later time.	Several possible causes: non-existent endpoint, customer proxy did not forward request to ArcFM services, etc. If error repeats upon re-try at a later time, copy test results, contact support, and include copy of test results.
      500	Internal Server Error	The server encountered an unexpected condition which prevented it from fulfilling the request.	Problem with ArcFM service endpoint.  Update to current version and try again. If error repeats, copy test results, contact support, and include copy of test results.
      502	Bad Gateway	The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request.	Most likely caused by customer firewall or proxy.  Could be a single endpoint or all.  If a single endpoint, add the service endpoint URL to the firewall and/or proxy and try again.  If error repeats, copy test results, contact support, and include copy of test results.

Application-Specific Services and Azure Service Bus Connectivity

Now that you’ve verified access to core services, it is then crucial to verify access to application-specific services and to the Azure Service Bus. Each XI series application provides details of the required connections and ports, and the ability to test the connections in bulk or individually. The ACE tool handles both core and application-specific services, but as mentioned above, the key difference is that to check application-specific services, the ACE tools needs to be installed on the same machine hosting the app you want to run.

1. Launch the ACE tool on the same machine that runs the XI series application you are testing. Ergo, if you are testing connectivity for Designer XI, run the tool on the same machine where Designer XI is installed.

   NOTE: If you want to run the ACE tool again, the installation path is: C:\Users\<username>\AppData\Local\ArcFM Connectivity Evaluator. You can right-click and pin the app to your taskbar.

2. Log in to your tenant.

   If your users have access to multiple tenants, they can switch between them using the tenant drop-down list.

   

3. Click an application.

   The interface displays plugin buttons for various ArcFM applications. The ones you see likely differ from these:

   

   • Autoupdater SOI – this SOI requires connectivity with all services on the Web Services tab, in the Not Tested column.

     • On the Service Bus tab, you can select a protocol to test, which is helpful if traffic to port 5671 is blocked, or if you want to test connectivity with port 5671 over TCP.

   • Design Storage – this service is storage for Designer XI designs (DNXs and DSRs), network extracts (GRRs), and other design files.

   • Designer – this app requires connectivity with several services. If your users need Designer XI in the field, ensure that you run these tests under those network conditions.

   • Edge Service and Sync Service – though connectivity to a few services is required, these services do most of their communicating using Azure Service Bus.

   • Editor, Feeder Services, and Markup Tools also need connectivity with various services, listed under Not Tested.

   • Mobile – users in the field rely on ArcFM Mobile for their devices to work, regardless of their connectivity status. To appropriately test Mobile connectivity, these tests need to be run under the typical scenario of a user in the field.

   • Solution Center – all ArcFM applications are configured in Solution Center and require connectivity to several crucial services.

4. Click Open Test Report to generate a PDF version of the test results, or Open Reports Location to view the folder where reports are being saved.