ArcFM Connectivity Evaluator (ACE)

The ArcFM Connectivity Evaluator (ACE) 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 before performing Solution Center configurations or any app configurations, as you need connectivity for the configurations to work.

When using the ACE tool, keep the following in mind:

• The ACE installer can be downloaded on the myArcFM page ArcFM Solution Center.

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

  IMPORTANT: If you are having basic connectivity issues, you might need to allowlist the tenancy service itself, which is https://tenancy.arcfmsolution.com.

• The ACE tool can be run as many times as needed until all issues are corrected. This is particularly true throughout the implementation process.

Verify Core Outbound URL Access

Verifying access to the 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. If necessary, download the ACE tool on the myArcFM page ArcFM Solution Center.

2. Install the ACE tool.

   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. All you need to check core outbound URLs is the ACE tool and the tenant ID. Now, to verify access to other services and the Azure Service Bus, the ACE tool needs to be installed on the same machine as the actual application. This is covered below in this same help topic.

3. Launch the ACE tool.

4. If this is the first time you have launched the ACE tool, type your tenant ID into the “organization’s name” field, then click Submit.

   

   IMPORTANT: Your tenant ID was created for you by the Schneider Electric implementation team after you requested a tenant via arcfmreadiness@schneider-electric.com. It is typically your organization name with no spaces or special characters. Further, it is common to have multiple tenants during your implementation. Some common examples are a “Dev” tenant, “Test” tenant, “Train” tenant, “Prod” tenant, etc.

5. To check core outbound URLs, you do not need to log in (that is covered in this same help topic below).

6. Click the “View ‘Tenant Name’ Allowlist” button.

   

7. The interface displays icons for the specific services and for “All Services.”

   1. To see all the required URLs for all services, click “All Services.”

      1. Click “Open Services Report” to generate a PDF of service URLs. This is a great way to share the URLs that require allowlisting.

   2. To test access to the actual URLs, click the desired service icon (for example, the Login Info icon).

      1. You can test services individually, or click the Test All icon to start the process (the URLs in the following image are just examples and your URLs differ).

         

         
         

         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. These are standard descriptions taken from the Internet Engineering Task Force (IETF) protocols.

         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.

      2. Optionally, click Open Test Report to generate a PDF version of the test results.

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

Verify Application-Specific Services and Connectivity to Azure Service Bus

As stated above, verifying access to core services is a prerequisite before essentially all implementation steps.

Going a step further, after verifying core services, it is also critical 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 the key difference is in order to check application-specific services, the ACE needs to be installed on the same machine hosting the app itself.

1. If necessary, download the ACE tool on the myArcFM page ArcFM Solution Center.

2. Install the ACE tool on the same machine that runs the XI application you are testing. In other words, if you are testing connectivity for Designer XI, run the tool on the same machine where Designer XI is installed.

3. Launch the ACE tool.

4. If this is the first time you have launched the ACE tool, type your tenant ID into the “organization’s name” field, then click Submit.

   

   IMPORTANT: Your tenant ID was created for you by the Schneider Electric implementation team after you requested a tenant via arcfmreadiness@schneider-electric.com. It is typically your organization name with no spaces or special characters. Further, it is common to have multiple tenants during your implementation. Some common examples are a “Dev” tenant, “Test” tenant, “Train” tenant, “Prod” tenant, etc.

5. Log into your tenant. The login methods were established when your tenant was created, and your choices likely vary from the following image.

   

6. The interface displays icon for the various, application-specific services in addition to “All Services.”

7. Just as explained above, “All Services” provides a view-only list of URLs.

8. And, to test connectivity to a service, click the desired service icon (for example, the Solution Center icon), then click the Test All icon to test access.

9. Optionally, click “Open Test Report” to generate a PDF version of the test results.

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