Run the ACE Tool as Network Service
As stated in the previous help topic, the core function of the ACE tool is to test and verify connectivity to ArcFM services.
The Mobile Sync Service, the Edge Service, and the Redlining Service do most of their communication using the messaging service called Azure Service Bus. This often requires special consideration from your company’s IT department. Further, to accurately validate their connectivity, the ACE tool should be run as Network Service instead of as a signed-in user.
An easy way to run the connectivity tests for these services as Network Service is to use the windows Task Scheduler. Further, because you will most likely run the tests multiple times, the Task Scheduler is an easy way to save all the arguments and run the command as needed.
Before you begin, you need to know the following:
-
The service name you are testing (these are provided below in this help topic)
-
The Client ID that was created for the service’s API key
-
The Client Secret ID that was created for the service’s API key
-
The tenant name
To run the tool as Network Service using Window Task Scheduler, follow these steps:
- Open Task Scheduler.
- Under Actions, click Create Task.
- For Name, type a descriptive name. For example, if creating a task for the Sync Service, the name could be RunAceTool_SyncService.
- Under Security Options, click Change User or Group.
- For the object name to select, type NETWORK SERVICE, then click OK.
- Confirm you see NETWORK SERVICE as the user account.
- Click the Actions tab.
- Click the New button to create a new Action.
- For Action, choose Start a program.
- For Program/script, click the Browse button.
- Navigate to C:\Users\username\AppData\Local\ArcFMConnectivityEvaluator\app-version
#IMPORTANT:
-
Always navigate into the app folder with the most recent (highest) version number, and use the .exe in the app folder. Do not run the arguments against the generic .exe in the ArcFMConnectivityEvaluator folder.
-
If the ACE tool goes through an update that changes the version number, you need to re-visit this configuration to navigate into the updated app version folder.
-
- Click the SE.Geospatial.ArcFMConnectivityEvaluator application, then click Open.
- The last configuration involves adding the arguments to
the action. These include which service to test, the Client ID, the
Client Secret, and the tenant name. Because the Add arguments field
is small in the New Action dialog, it is best to type the arguments
in another application (for example, Notepad, Notepad ++, Linqpad,
etc.), then paste them into the arguments field. Here is an example
of an argument:
arcfmconnectivityevaluator://?appName=Sync%20Service&testTab=ServiceBus&runTests=true&saveResults=true&serviceBusTransportType= AmqpWebSockets&outputFolder=C:\AceToolOutput&exitOnCompletion=true&apiKeyClientId=***&apiKeyClientSecret***&apiKeyTenantId=***
- For the “appName” portion of the argument,
here are the possible values:
-
Sync Service:
-
Sync%20Service&testTab=ServiceBus
-
Sync%20Service&testTab=WebServices
-
-
Redlining Service:
-
Redlining%20Service&testTab=ServiceBus
-
Redlining%20Service&testTab=WebServices
-
-
Edge Service:
-
Edge%20Service&testTab=ServiceBus
-
Edge%20Service&testTab=WebServices
-
-
- For the “outputFolder,” you can use the default or change the output folder location.
- For the “apiKeyClientId,” paste the Client ID that was generated when the service’s API key was created.
- For the “apiKeyClientSecret,” paste the Client Secret ID that was generated when the service’s API key was created.
- For the “apiKeyTenantId,” type your tenant name (typically your organization’s name).
- For the “appName” portion of the argument,
here are the possible values:
- With the argument fully typed, test it to make sure the syntax and API keys are correct. To do so, paste the full argument into a web browser and execute it. If typed correctly, the ACE tool launches and executes the configured tests.
- After testing the argument, copy and paste it into the Add Arguments field (this field does not accept carriage returns, so ensure the argument is typed without them).
- Click OK to close the New Action dialog.
- Click OK to save the task and close the Create Task dialog.
- You can now run your task any time from the Task Scheduler Library.