Configuring an Assembly Connection via the Command Line Installer
Before you start
- Generally, we recommend that the Assembly Connector is installed and configured using our regular onboarding tool. Instructions for this can be found here and - unless specifically directed otherwise - we recommend you use that method to install.
- Sometimes, our regular onboarding tool is not supported on older versions of Windows, or it is blocked from communicating with the Assembly Connector service. In these cases, we recommend using the command line installer, detailed in this guide.
- In order to use our command line installer, you will still need to download the Assembly setup file from the Assembly Platform and run it on your machine. This will install an Assembly Connector service.
Step 1 - Navigate to the Command Line Installer
- To access the installer, go to C:\ProgramData\Assembly\Versions\Connector\jwrtfqnt\cli on the machine.
- Please note: the "hash" section of that path ("jwrtfqnt" above) can change with each update, so may be different on your machine. If there are multiple folders within the Connector folder, please select the one with the latest Date Modified.
- In this folder, locate the onboarding_cli.exe, right-click and Run as administrator.
Step 2 - Check the Onboarding tool can communicate with the Assembly Connector Service
- Running the tool will launch a command prompt on the machine, which will talk you through the configuration steps.
- The first step is to make sure the tool can communicate with the Assembly Connector service, hit Enter to test this.
- If successful, you will receive the message: "Great, we can talk to the Connector Service."
- If unsuccessful, please contact email@example.com and we will advise on how to proceed.
Step 3 - Configure your Proxy (optional)
- The next step is to configure your proxy, if the school uses one.
- If the school does not use a proxy, type no and our tool will attempt to reach a series of URLs with a direct connection.
- If the school does use a proxy, type yes then enter the proxy information (URL is compulsory, but the other fields for username, password and domain are often not required - you can hit Enter to skip over these.
- If we're able to communicate with the necessary URLs you will receive the following message:
- If any URLs come up as unreachable, you will need to ensure that the local system account on the server can access *.assembly.education URLs. If you have network level filtering (such as proxy servers or firewalls), you should add an allow rule for *.assembly.education URLs (or the individual URLs listed above) to the web filter on ports 80 and 443.
Step 4 - Enter your Key and Secret
- The next step is to enter your key and secret, which you can retrieve from the Connector page of the Platform.
- You can paste it in to the command line tool by right-click the bar on the top, going to Edit > Paste.
- Do the same with the Platform Secret.
Step 5 - Enter your SIMS credentials
- The final step is to enter your SIMS credentials.
- First, type SIMS as the MIS you want to use
- Type the name of a SIMS User - you should ensure they are in all the correct permissions groups on SIMS.
- Type the SIMS password for that user. Please note: the password will not appear on the screen as you type or paste it.
- Enter the server or hostname for your SIMS server.
- Enter the SIMS database name.
- Hit enter, if the credentials you've enter are correct, you'll get a message saying we are now connected!
- You're now able to authorise an app and get data to flow.