Install the Add-On Components

---

IMPORTANT
The Server Components must have been installed, licenced and implemented before any add-ons can be installed.

---

This page is split in to two sections.

The first Section Automatic Deployment covers the steps required when using the SmartDeployServer binary.
The second section Manual Deployment covers the steps required if you have manually installed a component.

Depending on which method of installation you have chosen, go to the appropriate section.

You are strongly advised wherever possible to use the Automatic Deployment option, however in some isolated cases, manual is more suitable.

NOTE: These instructions are at quite a high level, but follow them carefully and you shouldn't get any problems.
NOTE: You're advised to have Notepad / Notepad ++ open as there are a few values you'll need to take note of during the installation.

---

SmartConnect - Pre-Installation Procedure

Before beginning the installation (whether automatically or manually) please perform the following steps.
They can be done at any time in advance of installing the Addon components:

Step 1 - In your web browser of choice, navigate to 127.0.0.1:5002 and login as an administrative user
Step 2 - Change the url from /portal to /config, press enter
Step 3 - Click Configure Integration server
Step 4 - Scroll down until you see the Unique ID of Server value, keep this safe (copy to your clipboard / paste into Notepad). Close your browser.
Step 5 - Contact the Support team requesting registration of SmartConnect, they will ask you for this value (or to email it to them)
Step 6 - You will then be sent a client_token.json file via email
Step 7 - Copy this file in to the C:\V1Home\SmartSuite\IntegrationServer\licences directory
Step 8 - Restart the V1IntegrationServer service
Step 9 - Again, in your web browser of choice, navigate to 127.0.0.1:5002 and login as an administrative user
Step 10 - Change the url from /portal to /config, press enter
Step 11 - Click Configure Integration server
Step 12 - Take a copy of the Assigned client ID, keep it safe (copy to your clipboard / paste into Notepad), you will need it during the install of SmartConnect

This completes the SmartConnect - Pre-Installation Procedure, the Addon components can now be installed.

---

Automatic Deployment

The SmartDeployAddon binary is based on PowerShell, it asks relevant questions about your environment before allowing you to choose which add-ons to download and install.

---

Pre-Requisites

The Server Components have been installed.
There are no vault-clusterXXX.json files in your \Downloads directory. (NOTE: If there are, remove them.)
You do not have services.msc or RegEdit open (NOTE: if you do, please close them.)

---

Assumptions

The Server Components have been installed to a root directory of C:\V1Home

NOTE: SmartDeployAddon will automatically detect this path and install all add-on components at this level beneath the root directory.
If not found, no add-on installations will be permitted.

---

SmartDeployAddon

Now the Pre-Requisites have been satisifed, you can run SmartDeployAddon.

• Download SmartDeployAddon from the Server Components page.
• Un-compress to a temporary location on disk (NOTE: Do not run from within the zip file, it must be un-compressed first)
• Right click and RUN AS ADMINISTATOR (this is very important)
• A check is done on execution policy rights, if asked, press Y, then enter (to indicate you are happy to execute the binary)
• A check is done on the version of Powershell found
• A check is done on the version of .NET found
• A check is done on a decent internet connection
• You are asked to confirm you have read and understood the pre-requisites
• Where found, the root location of the V1Core components is located, beneath which all add-ons are installed
• We then get into the physical act of installing each component in the following order as a Y/N

• Vault
• Follow these steps very carefully, step by step. It will only take a minute but is crucial to the functionality of all add-ons.
• Vault is the secrets engine SmartConnect and it's Add-ons are dependent on, it installs silently, then opens your browser
• Where prompted for Key shares, enter 1
• Where prompted for Key threshold, enter 1
• Click Initialize
• Click Download keys
  
  When downloaded, copy the keys *.json file from your downloads area to the C:\V1Home\V1Vault directory.
  
  
• Open the file in your text editor of choice (Notepad++ for instance) and copy the keys_base64 (the text between the quotes) to your clipboard
• Click Continue to Unseal
• Where prompted for Master Key Portion, paste the keys_base64 value you copied
• Click Unseal
• Go back to the keys file, this time copy the root_token (the text between the quotes) to your clipboard
• Where prompted for Token, paste the root_token value you copied
• Click Sign In
• Click Enable new engine ... (Top right of the screen)
• Click the radio button in the Generic section beneath KV
• Click Next
• In the Version dropdown, select 1
  
  NOTE: THIS IS VERY IMPORTANT, MAKE ABSOLUTELY SURE IT'S 1
  
  
• Click Enable Engine
• Close your browser and return to SmartDeployAddon (you'll be asked to press a key to continue now the above steps have been completed)

• V1HouseKeepingManagement
• Installs V1HouseKeepingManagement silently

• V1Logs2Email
• Installs V1Logs2Email silently

• V1UpdateService
• Installs V1UpdateService silently

• SmartConnect
• Installs SmartConnect interactively (step-by-step procedure below)

            Step 1 - Enter a path to install SmartConnect, you're advised to install it beneath the root directory of the Server components, i.e. C:\V1Home\SmartConnect, click Next
            Step 2 - The license server URL is checked, press tab (connection to it is established)
            Step 3 - Paste in the assigned client ID you took at the final step of the Pre-Installation Procedure, press tab (at this point it is validated)
            Step 4 - Browse to the C:\V1Home\SmartSuite\IntegrationServer\licences\client_token.json you were sent by support as per the Pre-Installation Procedure
            Step 5 - Click Register (this communicate with the license server to establish trust between your server and the V1 license server)
            Step 6 - If all is well, it will activate the paths / ports. Set the paths to your desired location
            Step 7 - Set the NIS URL, press tab to validate it's connection (including port)
            Step 8 - Vault connection is validated, browse to the vault keys files you copied to the C:\V1Home\V1Vault dir as part of the install process
            Step 9 - Where you have all green ticks, click Install, when completed, click close
            Step 10 - Return to SmartDeployAddon to complete the setup of addons

After the installation has completed, you are asked if you want to purge the zip file to preserve disk space (Y / N).

The destination directory is opened so you can review the locations of each add-on respectively.

---

SmartConnect

Open services.msc
Set the V1SmartConnect service to be Automatic (delayed)

---

Manual Deployment

All add-ons rely on SmartConnect, the API allowing connectivity between the V1 Server and Client components with the FMS and their integration.

These can be implemented manually via the SmartConnect technical portal.